Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Aspire.Hosting.Go/Aspire.Hosting.Go.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
</PropertyGroup>

<ItemGroup>
<Compile Include="$(SharedDir)PublishValidationExtensions.cs" Link="PublishValidationExtensions.cs" />
<ProjectReference Include="..\Aspire.Hosting\Aspire.Hosting.csproj" />
</ItemGroup>

Expand Down
37 changes: 5 additions & 32 deletions src/Aspire.Hosting.Go/GoHostingExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -332,38 +332,11 @@ public static IResourceBuilder<GoAppResource> AddGoApp(
if (builder.ExecutionContext.IsPublishMode &&
builder.TryCreateResourceBuilder<ContainerResource>(resource.Name, out var containerBuilder))
{
var validationStepName = $"validate-go-dockerfile-package-path-{resource.Name}";

// The step is added to the pipeline instead of as a PipelineStepAnnotation on the container because
// WithDockerfile replaces the container's step annotation, which would drop this step (or throw when
// more than one exists) if the Dockerfile is configured again after this point.
builder.Pipeline.AddStep(new PipelineStep
{
Name = validationStepName,
Description = $"Warns when Go app '{resource.Name}' publishes an existing Dockerfile that ignores its package path.",
RequiredBySteps = [WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
Resource = containerBuilder.Resource,
Action = context =>
{
// A resource excluded from the manifest is never published, so there is nothing to warn about.
if (!containerBuilder.Resource.IsExcludedFromPublish())
{
WarnIfExistingDockerfileIgnoresPackagePath(resource, containerBuilder.Resource, context.Logger);
}

return Task.CompletedTask;
}
});

// Deploy environments such as Azure Container Apps run the image build step without the aggregate
// Build step, so the image build must wait for this step itself to surface the warning before a
// potentially long build instead of after it.
containerBuilder.WithPipelineConfiguration(context =>
{
var validationStep = context.GetSteps(containerBuilder.Resource).FirstOrDefault(step => step.Name == validationStepName);

context.GetSteps(containerBuilder.Resource, WellKnownPipelineTags.BuildCompute).DependsOn(validationStep);
});
containerBuilder.AddPublishValidation(
$"validate-go-dockerfile-package-path-{resource.Name}",
$"Warns when Go app '{resource.Name}' publishes an existing Dockerfile that ignores its package path.",
[WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
context => WarnIfExistingDockerfileIgnoresPackagePath(resource, containerBuilder.Resource, context.Logger));
}

// Ensure source resources (that provide container files) build before this Go image.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<Compile Include="$(SharedDir)BrowserDebuggerResource.cs" Link="BrowserDebuggerResource.cs" />
<Compile Include="$(SharedDir)BrowserLaunchConfiguration.cs" Link="BrowserLaunchConfiguration.cs" />
<Compile Include="$(SharedDir)PathNormalizer.cs" Link="Utils\PathNormalizer.cs" />
<Compile Include="$(SharedDir)PublishValidationExtensions.cs" Link="PublishValidationExtensions.cs" />
</ItemGroup>

<ItemGroup>
Expand Down
51 changes: 19 additions & 32 deletions src/Aspire.Hosting.JavaScript/JavaScriptHostingExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1901,8 +1901,6 @@ private static IResourceBuilder<TResource> CreateDefaultJavaScriptAppBuilder<TRe
if (builder.ExecutionContext.IsPublishMode &&
builder.TryCreateResourceBuilder<ContainerResource>(resource.Name, out var containerBuilder))
{
var validationStepName = $"validate-javascript-dockerfile-run-script-{resource.Name}";

Task WriteValidatedContainerAsync(ManifestPublishingContext context)
{
ValidateExistingDockerfileRunScript(resource, containerBuilder.Resource);
Expand All @@ -1911,18 +1909,11 @@ Task WriteValidatedContainerAsync(ManifestPublishingContext context)

resourceBuilder.WithManifestPublishingCallback(WriteValidatedContainerAsync);
containerBuilder.WithManifestPublishingCallback(WriteValidatedContainerAsync);
containerBuilder.WithAnnotation(new PipelineStepAnnotation(_ => new PipelineStep
{
Name = validationStepName,
Description = $"Validates that JavaScript app '{resource.Name}' does not publish an ignored run script with an existing Dockerfile.",
RequiredBySteps = [WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
Resource = containerBuilder.Resource,
Action = _ =>
{
ValidateExistingDockerfileRunScript(resource, containerBuilder.Resource);
return Task.CompletedTask;
}
}));
containerBuilder.AddPublishValidation(
$"validate-javascript-dockerfile-run-script-{resource.Name}",
$"Validates that JavaScript app '{resource.Name}' does not publish an ignored run script with an existing Dockerfile.",
[WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
_ => ValidateExistingDockerfileRunScript(resource, containerBuilder.Resource));
}

resourceBuilder.WithVSCodeDebugging();
Expand Down Expand Up @@ -2192,6 +2183,9 @@ public static IResourceBuilder<ViteAppResource> AddViteApp(this IDistributedAppl
/// <para>
/// The Next.js application must have <c>output: "standalone"</c> configured in <c>next.config.ts</c>
/// and a <c>public/</c> directory (even if empty) for the published container to build correctly.
/// The standalone output check runs before the container image build during publish and deployment,
/// including Azure Container Apps and App Service. Resources excluded from publishing are not validated.
/// Use <see cref="DisableBuildValidation"/> when the configuration cannot be statically inspected.
/// </para>
/// <example>
/// The following example creates a Next.js app.
Expand Down Expand Up @@ -2253,29 +2247,22 @@ public static IResourceBuilder<NextJsAppResource> AddNextJsApp(this IDistributed
}
}

// Add a publish prereq step that validates the Next.js config has standalone output enabled.
// This runs at deploy time (not resource creation time) so it doesn't block `aspire start`.
// Can be disabled with .DisableBuildValidation().
resourceBuilder.WithAnnotation(new PipelineStepAnnotation(factoryCtx =>
[
new PipelineStep
{
Name = $"nextjs-standalone-check-{name}",
Description = $"Validates that the Next.js app '{name}' has output: \"standalone\" configured.",
DependsOnSteps = [WellKnownPipelineSteps.BuildPrereq],
RequiredBySteps = [WellKnownPipelineSteps.Build],
Resource = resourceBuilder.Resource,
Action = _ =>
if (builder.ExecutionContext.IsPublishMode &&
builder.TryCreateResourceBuilder<ContainerResource>(name, out var containerBuilder))
{
var validationStep = containerBuilder.AddPublishValidation(
$"nextjs-standalone-check-{name}",
$"Validates that the Next.js app '{name}' has output: \"standalone\" configured.",
[WellKnownPipelineSteps.Build],
_ =>
{
if (!resourceBuilder.Resource.TryGetLastAnnotation<SuppressPublishValidationAnnotation>(out var suppress))
{
ValidateNextJsStandaloneOutput(appDirectory);
}

return Task.CompletedTask;
}
}
]));
});
validationStep.DependsOn(WellKnownPipelineSteps.BuildPrereq);
}

return resourceBuilder;
}
Expand Down
1 change: 1 addition & 0 deletions src/Aspire.Hosting.Python/Aspire.Hosting.Python.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
</ItemGroup>

<ItemGroup>
<Compile Include="$(SharedDir)PublishValidationExtensions.cs" Link="PublishValidationExtensions.cs" />
</ItemGroup>

<ItemGroup>
Expand Down
36 changes: 5 additions & 31 deletions src/Aspire.Hosting.Python/PythonAppResourceBuilderExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -485,39 +485,13 @@ Task WriteValidatedContainerAsync(ManifestPublishingContext context)
return context.WriteContainerAsync(containerBuilder.Resource);
}

var validationStepName = $"validate-python-dockerfile-entrypoint-{resource.Name}";

resourceBuilder.WithManifestPublishingCallback(WriteValidatedContainerAsync);
containerBuilder.WithManifestPublishingCallback(WriteValidatedContainerAsync);
// The step is added to the pipeline instead of as a PipelineStepAnnotation on the container because
// WithDockerfile replaces the container's step annotation, which would drop this step (or throw when
// more than one exists) if the Dockerfile is configured again after this point.
builder.Pipeline.AddStep(new PipelineStep
{
Name = validationStepName,
Description = $"Validates that Python app '{resource.Name}' does not publish an ignored entrypoint with an existing Dockerfile.",
RequiredBySteps = [WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
Resource = containerBuilder.Resource,
Action = _ =>
{
// A resource excluded from the manifest is never published, so it must not fail the pipeline.
if (!containerBuilder.Resource.IsExcludedFromPublish())
{
ValidateExistingDockerfileEntrypoint(resource, containerBuilder.Resource, entrypointType, entrypoint);
}

return Task.CompletedTask;
}
});

// Deploy environments such as Azure Container Apps run the image build step without the aggregate
// Build step, so the image build must wait for the validation itself.
containerBuilder.WithPipelineConfiguration(context =>
{
var validationStep = context.GetSteps(containerBuilder.Resource).FirstOrDefault(step => step.Name == validationStepName);

context.GetSteps(containerBuilder.Resource, WellKnownPipelineTags.BuildCompute).DependsOn(validationStep);
});
containerBuilder.AddPublishValidation(
$"validate-python-dockerfile-entrypoint-{resource.Name}",
$"Validates that Python app '{resource.Name}' does not publish an ignored entrypoint with an existing Dockerfile.",
[WellKnownPipelineSteps.Build, WellKnownPipelineSteps.Publish],
_ => ValidateExistingDockerfileEntrypoint(resource, containerBuilder.Resource, entrypointType, entrypoint));
}

resourceBuilder.WithPipelineConfiguration(context =>
Expand Down
46 changes: 46 additions & 0 deletions src/Shared/PublishValidationExtensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Aspire.Hosting.ApplicationModel;
using Aspire.Hosting.Pipelines;

namespace Aspire.Hosting;

internal static class PublishValidationExtensions
{
internal static PipelineStep AddPublishValidation(
this IResourceBuilder<ContainerResource> builder,
string stepName,
string description,
string[] requiredBySteps,
Action<PipelineStepContext> validate)
{
var step = new PipelineStep
{
Name = stepName,
Description = description,
RequiredBySteps = [.. requiredBySteps],
Resource = builder.Resource,
Action = context =>
{
// Exclusion can be configured after registration. An unpublished resource must not fail validation.
if (!builder.Resource.IsExcludedFromPublish())
{
validate(context);
}

return Task.CompletedTask;
}
};

// WithDockerfile replaces container step annotations, so keep validation in the application pipeline.
builder.ApplicationBuilder.Pipeline.AddStep(step);
builder.WithPipelineConfiguration(context =>
{
// Azure deploy graphs select BuildCompute directly, without the aggregate Build or Publish steps.
context.GetSteps(builder.Resource, WellKnownPipelineTags.BuildCompute).DependsOn(stepName);
});

return step;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable ASPIREJAVASCRIPT001 // Type is for evaluation purposes only
#pragma warning disable ASPIRECOMPUTE003 // Type is for evaluation purposes only

using Aspire.Hosting.ApplicationModel;
using Aspire.Hosting.Pipelines;
using Aspire.Hosting.Utils;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging.Abstractions;

namespace Aspire.Hosting.Azure.Tests;

public class JavaScriptPublishValidationTests(ITestOutputHelper outputHelper)
{
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task DeployGraphRequiresJavaScriptAndNextJsValidationBeforeImageBuilds(bool appService)
{
using var workspace = TemporaryWorkspace.Create(outputHelper);
using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish, step: "inspect");
if (appService)
{
builder.AddAzureAppServiceEnvironment("env");
}
else
{
builder.AddAzureContainerAppEnvironment("env");
}

builder.AddJavaScriptApp("js", workspace.Path)
.PublishAsPackageScript("start")
.WithHttpEndpoint(port: 3001)
.WithExternalHttpEndpoints();
builder.AddNextJsApp("nextjs", workspace.Path).WithExternalHttpEndpoints();

IReadOnlyList<PipelineStep> graph = [];
builder.Pipeline.AddStep("inspect", _ => Task.CompletedTask);
builder.Pipeline.AddPipelineConfiguration(context =>
{
graph = context.Steps.ToArray();
return Task.CompletedTask;
});

using var app = builder.Build();
await AzureManifestUtils.ExecuteBeforeStartHooksAsync(app, TestContext.Current.CancellationToken);
await app.Services.GetRequiredService<IDistributedApplicationPipeline>().ExecuteAsync(
new PipelineContext(
app.Services.GetRequiredService<DistributedApplicationModel>(),
app.Services.GetRequiredService<DistributedApplicationExecutionContext>(),
app.Services,
NullLogger.Instance,
TestContext.Current.CancellationToken));

Assert.True(Reaches(WellKnownPipelineSteps.Deploy, "build-js"));
Assert.True(Reaches(WellKnownPipelineSteps.Deploy, "build-nextjs"));
Assert.True(Reaches("build-js", "validate-javascript-dockerfile-run-script-js"));
Assert.True(Reaches("build-nextjs", "nextjs-standalone-check-nextjs"));
Assert.True(Reaches(WellKnownPipelineSteps.Deploy, "validate-javascript-dockerfile-run-script-js"));
Assert.True(Reaches(WellKnownPipelineSteps.Deploy, "nextjs-standalone-check-nextjs"));

bool Reaches(string from, string target)
{
var visited = new HashSet<string>(StringComparer.Ordinal);
bool Visit(string name) => name == target || (visited.Add(name) &&
graph.Single(step => step.Name == name).DependsOnSteps.Any(Visit));

return Visit(from);
}
}
}
Loading
Loading