generated from dotnet/new-repo
-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Task and Targets #38
Closed
Closed
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
ca11a94
Add System.Containers.Tasks
benvillalobos ac63bf2
Bring in the targets
benvillalobos b071654
Set up references and update API call
benvillalobos bcbf0c6
Remove useless packageversions
benvillalobos 5f9d531
Preserve relative publish folder paths
benvillalobos 5a9a7a9
WIP E2E test
benvillalobos 5e087fd
intentionally fail WIP UT
benvillalobos cb93c2a
Follow task packaging tutorial
benvillalobos 8e19f55
WIP packaging code
benvillalobos 8a70398
Package modifications
benvillalobos 930c55a
Fix E2E test
benvillalobos 932df37
Merge branch 'main' into task-and-targets
benvillalobos 5e1a3a1
Remove todo's from targets
benvillalobos 42135de
Ship package to other test project
benvillalobos a02092d
Improve debugging in DockerRegistryManager & CreateNewImage
benvillalobos File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
| using System.Resources; | ||
| using System.Text; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
|
|
||
| #nullable disable | ||
|
|
||
| namespace System.Containers.Tasks | ||
| { | ||
| public class CreateNewImage : Microsoft.Build.Utilities.Task | ||
| { | ||
| /// <summary> | ||
| /// Base image name. | ||
| /// </summary> | ||
| [Required] | ||
| public string BaseImageName { get; set; } | ||
|
|
||
| [Required] | ||
| public string BaseImageTag { get; set; } | ||
|
|
||
| [Required] | ||
| public string InputRegistryURL { get; set; } | ||
|
|
||
| [Required] | ||
| public string OutputRegistryURL { get; set; } | ||
|
|
||
| [Required] | ||
| public ITaskItem[] Files { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// $(ContainerWorkingDirectory) | ||
| /// </summary> | ||
| [Required] | ||
| public string WorkingDirectory { get; set; } | ||
|
|
||
| [Required] | ||
| public string NewImageName { get; set; } | ||
|
|
||
| [Required] | ||
| public string Entrypoint { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Arguments to pass alongside Entrypoint. | ||
| /// </summary> | ||
| public string EntrypointArgs { get; set; } | ||
|
|
||
| public string PublishDirectory { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// CreateNewImage needs to: | ||
| /// 1. Pull a base image (needs parameters: URL, BaseImage, BaseImageTag) | ||
| /// 2. Add output of build as a new layer | ||
| /// 3. Push image back to some registry (needs parameters: OutputURL, NewName, EntryPoint) | ||
| /// </summary> | ||
| /// <returns></returns> | ||
| public override bool Execute() | ||
| { | ||
| if (Files.Length == 0) | ||
| { | ||
| Console.WriteLine("Files is empty, aborting."); | ||
| return false; | ||
| } | ||
|
|
||
| Registry reg = new Registry(new Uri(InputRegistryURL)); | ||
|
|
||
| Image image; | ||
| try | ||
| { | ||
| image = reg.GetImageManifest(BaseImageName, BaseImageTag).Result; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Log.LogError("GetImageManifest Failed: {0}.\n{1}", ex.Message, ex.InnerException); | ||
| return false; | ||
| } | ||
|
|
||
| // Turn the build output from items into an array of filepaths | ||
| string[] filePaths = Files.Select((f) => f.ItemSpec).ToArray(); | ||
|
|
||
| // preserve the folder structure of items published | ||
| string[] relativeFilePaths = filePaths.Select((x) => Path.GetRelativePath(PublishDirectory, x)).ToArray<string>(); | ||
|
|
||
| List<(string file, string relativePath)> filesWithPaths = new List<(string file, string relativePath)>(); | ||
|
|
||
| for(int i = 0; i < filePaths.Length; i++) | ||
| { | ||
| Log.LogMessage("File {0} has relative path of {1}", filePaths[i], relativeFilePaths[i]); | ||
| filesWithPaths.Add((filePaths[i], relativeFilePaths[i])); | ||
| } | ||
|
|
||
| Layer newLayer = Layer.FromFiles(filesWithPaths.AsEnumerable()); | ||
|
|
||
| image.AddLayer(newLayer); | ||
| image.SetEntrypoint(Entrypoint, EntrypointArgs?.Split(' ').ToArray()); | ||
|
|
||
| Registry outputReg = new Registry(new Uri(OutputRegistryURL)); | ||
|
|
||
| try | ||
| { | ||
| outputReg.Push(image, NewImageName, BaseImageName).Wait(); | ||
| } | ||
| catch | ||
| { | ||
| Console.WriteLine("Registry.Push failed"); | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net7.0</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
| <GeneratePackageOnBuild>true</GeneratePackageOnBuild> | ||
|
|
||
| <IsPackable>true</IsPackable> | ||
|
|
||
| <TargetsForTfmSpecificBuildOutput> | ||
| $(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage | ||
| </TargetsForTfmSpecificBuildOutput> | ||
|
|
||
| <BuildOutputTargetFolder>tasks</BuildOutputTargetFolder> | ||
|
|
||
| <!-- Tell the SDK to generate a deps.json file --> | ||
| <GenerateDependencyFile>true</GenerateDependencyFile> | ||
|
|
||
| <!-- MSBuild tasks shouldn't be referenced. This is by design. --> | ||
| <NoWarn>NU5100;NU5128</NoWarn> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Build.Utilities.Core" PrivateAssets="all" ExcludeAssets="runtime" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\System.Containers\System.Containers.csproj" PrivateAssets="all"/> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Content Include="build\System.Containers.Tasks.props" Pack="true" PackagePath="build\" /> | ||
| <Content Include="build\System.Containers.Tasks.targets" Pack="true" PackagePath="build\" /> | ||
| </ItemGroup> | ||
|
|
||
| <!-- This target adds all of our PackageReference and ProjectReference's runtime assets to our package output. --> | ||
| <Target Name="CopyProjectReferencesToPackage" DependsOnTargets="ResolveReferences"> | ||
| <ItemGroup> | ||
| <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths)" | ||
| TargetPath="%(ReferenceCopyLocalPaths.DestinationSubPath)" /> | ||
| </ItemGroup> | ||
| </Target> | ||
|
|
||
| <!-- This target adds the generated deps.json file to our package output --> | ||
| <Target Name="AddBuildDependencyFileToBuiltProjectOutputGroupOutput" BeforeTargets="BuiltProjectOutputGroup" | ||
| Condition=" '$(GenerateDependencyFile)' == 'true'"> | ||
| <ItemGroup> | ||
| <BuiltProjectOutputGroupOutput Include="$(ProjectDepsFilePath)" TargetPath="$(ProjectDepsFileName)" | ||
| FinalOutputPath="$(ProjectDepsFilePath)" /> | ||
| </ItemGroup> | ||
| </Target> | ||
|
|
||
| <!-- Hacky workaround for the fact that we don't publish the package yet. --> | ||
| <Target Name="CopyNupkgToCustomFolder" AfterTargets="Pack"> | ||
| <Copy SourceFiles="$(OutDir)..\System.Containers.Tasks.1.0.0.nupkg" DestinationFiles="..\Test.System.Containers.Filesystem\package\System.Containers.Tasks.1.0.0.nupkg" /> | ||
| </Target> | ||
|
|
||
| </Project> |
14 changes: 14 additions & 0 deletions
14
System.Containers.Tasks/build/System.Containers.Tasks.props
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <taskForldername>tasks</taskForldername> | ||
| <taskFramework>net7.0</taskFramework> | ||
| <!--The folder where the custom task will be present. It points to inside the nuget package. --> | ||
| <CustomTasksFolder>$(MSBuildThisFileDirectory)..\$(taskForldername)\$(taskFramework)</CustomTasksFolder> | ||
| <!--Reference to the assembly which contains the MSBuild Task--> | ||
| <CustomTasksAssembly>$(CustomTasksFolder)\$(MSBuildThisFileName).dll</CustomTasksAssembly> | ||
| </PropertyGroup> | ||
|
|
||
| <!--Register our custom task--> | ||
| <UsingTask TaskName="$(MSBuildThisFileName).CreateNewImage" AssemblyFile="$(CustomTasksAssembly)"/> | ||
|
|
||
| </Project> |
50 changes: 50 additions & 0 deletions
50
System.Containers.Tasks/build/System.Containers.Tasks.targets
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <TargetFrameworkVersion>6.0</TargetFrameworkVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- Required targets dependencies --> | ||
| <PropertyGroup> | ||
| <PublishContainerDependsOn> | ||
| Build; | ||
| ComputeContainerConfig | ||
| </PublishContainerDependsOn> | ||
| </PropertyGroup> | ||
|
|
||
| <Target Name="ComputeContainerConfig" AfterTargets="Build;_CopyResolvedFilesToPublishPreserveNewest"> | ||
| <!-- Find everything in the publish directory --> | ||
| <ItemGroup> | ||
| <_BuildOutputsNonRelative Include="$(PublishDir)**\*.*"/> | ||
| <BuildOutputs Include="%(_BuildOutputsNonRelative.FullPath)"/> | ||
| </ItemGroup> | ||
|
|
||
| <!-- Container Defaults --> | ||
| <PropertyGroup> | ||
| <ContainerBaseImageName Condition="'$(ContainerBaseImageName)' == ''"></ContainerBaseImageName> | ||
| <ContainerBaseImageTag Condition="'$(ContainerBaseImageTag)' == '' and $([MSBuild]::VersionGreaterThanOrEquals('$(TargetFrameworkVersion)', 6.0))">6.0</ContainerBaseImageTag> | ||
| <ContainerBaseImage Condition="'$(ContainerBaseImage)' == ''">$(ContainerBaseImageName):$(ContainerBaseImageTag)</ContainerBaseImage> | ||
| <ContainerInputRegistryURL Condition="'$(ContainerInputRegistryURL)' == ''">http://localhost:5010</ContainerInputRegistryURL> | ||
| <ContainerOutputRegistryURL Condition="'$(ContainerOutputRegistryURL)' == ''">http://localhost:5010</ContainerOutputRegistryURL> | ||
| <ContainerImageName Condition="'$(ContainerImageName)' == ''">$(AssemblyName.ToLower())</ContainerImageName> | ||
| <ContainerImageTag Condition="'$(ContainerImageTag)' == ''">$(Version)</ContainerImageTag> | ||
| <ContainerWorkingDirectory Condition="'$(ContainerWorkingDirectory)' == ''">/app</ContainerWorkingDirectory> | ||
| <ContainerEntrypoint Condition="'$(ContainerEntrypoint)' == '' and '$(SelfContained)' != 'true'">dotnet $(TargetFileName)</ContainerEntrypoint> | ||
| <!-- https://gist.github.com/BenVillalobos/e5336491e683b87e7ec2a5322f58dfbe --> | ||
| <ContainerEntrypoint Condition="'$(ContainerEntrypoint)' == '' and '$(SelfContained)' == 'true'">$(ContainerWorkingDirectory)/$(AssemblyName)$(_NativeExecutableExtension)</ContainerEntrypoint> | ||
| <ContainerEntrypointArgs Condition="'$(ContainerEntrypointArgs)' == ''"></ContainerEntrypointArgs> | ||
| </PropertyGroup> | ||
| </Target> | ||
|
|
||
| <Target Name="PublishContainer" DependsOnTargets="$(PublishContainerDependsOn)" BeforeTargets="Publish"> | ||
| <CreateNewImage InputRegistryURL="$(ContainerInputRegistryURL)" | ||
| OutputRegistryURL="$(ContainerOutputRegistryURL)" | ||
| BaseImageName="$(ContainerBaseImageName)" | ||
| BaseImageTag="$(ContainerBaseImageTag)" | ||
| Files="@(BuildOutputs)" | ||
| WorkingDirectory="$(ContainerWorkingDirectory)" | ||
| NewImageName="$(ContainerImageName)" | ||
| Entrypoint="$(ContainerEntrypoint)" | ||
| EntrypointArgs="$(ContainerEntrypointArgs)" | ||
| PublishDirectory="$(MSBuildProjectDirectory)\$(PublishDir)"/> | ||
| </Target> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it'll be important to document that the Entrypoint needs to be a fully-rooted path. I could see users doing something like
and attempting to package up an executable at what is effectively
/$(AppName), which won't exist.Maybe there's some validation we can do here to save them: either checking that a fully-rooted path was provided, or attempting to 'root' a relative or un-rooted path against the
ContainerWorkingDirectory.