Skip to content
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

chore: Add console app to upload Docker images to ECR #791

Merged
merged 2 commits into from
Oct 4, 2023
Merged
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
44 changes: 44 additions & 0 deletions .github/workflows/UploadDockerImage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Pushes Docker images created from the deploy tool's Dockerfile templates to an internal ECR so that they can be scanned for security vulnerabilities.
name: Upload Docker Images
96malhar marked this conversation as resolved.
Show resolved Hide resolved

on:
# Manually trigger on specific branches
workflow_dispatch:
push:
branches:
- main

permissions:
id-token: write

jobs:
upload-docker-images:
runs-on: ubuntu-latest
steps:
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@8c3f20df09ac63af7b3ae3d7c91f105f857d8497 #v4
96malhar marked this conversation as resolved.
Show resolved Hide resolved
with:
aws-region: us-west-2
role-to-assume: ${{ secrets.DOCKER_IMAGE_UPLOADER_ROLE }}
role-duration-seconds: 1800

- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup .NET Core 6.0
uses: actions/setup-dotnet@v3
with:
dotnet-version: 6.0.x

- name: Restore dependencies
run: dotnet restore

- name: Build
run: dotnet build --no-restore

- name: Run Docker Image Uploader
run: |
cd ./test/AWS.Deploy.DockerImageUploader
dotnet run --project ./AWS.Deploy.DockerImageUploader.csproj
7 changes: 7 additions & 0 deletions AWS.Deploy.sln
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWS.Deploy.DocGenerator", "
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWS.Deploy.DocGenerator.UnitTests", "test\AWS.Deploy.DocGenerator.UnitTests\AWS.Deploy.DocGenerator.UnitTests.csproj", "{7E661545-7DFD-4FE3-A5F9-767FAE30DFFE}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWS.Deploy.DockerImageUploader", "test\AWS.Deploy.DockerImageUploader\AWS.Deploy.DockerImageUploader.csproj", "{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -173,6 +175,10 @@ Global
{7E661545-7DFD-4FE3-A5F9-767FAE30DFFE}.Debug|Any CPU.Build.0 = Debug|Any CPU
{7E661545-7DFD-4FE3-A5F9-767FAE30DFFE}.Release|Any CPU.ActiveCfg = Release|Any CPU
{7E661545-7DFD-4FE3-A5F9-767FAE30DFFE}.Release|Any CPU.Build.0 = Release|Any CPU
{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69}.Debug|Any CPU.Build.0 = Debug|Any CPU
{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69}.Release|Any CPU.ActiveCfg = Release|Any CPU
{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -204,6 +210,7 @@ Global
{CEEBEC39-40E5-4A9B-878A-6EDB52B9B43E} = {C3A0C716-BDEA-4393-B223-AF8F8531522A}
{6D4BD0C2-C2A0-4AFB-BC22-623DD64A4F84} = {11C7056E-93C1-408B-BD87-5270595BBE0E}
{7E661545-7DFD-4FE3-A5F9-767FAE30DFFE} = {BD466B5C-D8B0-4069-98A9-6DC8F01FA757}
{49A1C020-F4C8-4B28-A6B2-6AD3C8452E69} = {BD466B5C-D8B0-4069-98A9-6DC8F01FA757}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {5A4B2863-1763-4496-B122-651A38A4F5D7}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\..\src\AWS.Deploy.CLI\AWS.Deploy.CLI.csproj" />
</ItemGroup>

</Project>
78 changes: 78 additions & 0 deletions test/AWS.Deploy.DockerImageUploader/App.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

using AWS.Deploy.Common.IO;
using AWS.Deploy.Common;
using Microsoft.Extensions.DependencyInjection;
using System.Reflection;
using System.Collections.Generic;
using System;
using System.Threading.Tasks;
using System.IO;

namespace AWS.Deploy.DockerImageUploader
{
/// <summary>
/// This serves as the dependency injection container for the console application.
/// </summary>
public class App
{
private readonly IFileManager _fileManager;
private readonly IDirectoryManager _directoryManager;
private readonly IProjectDefinitionParser _projectDefinitionParser;
private readonly CLI.App _deployToolCli;

private readonly List<string> _testApps = new() { "WebApiNET6", "ConsoleAppTask" };

public App(IServiceProvider serviceProvider)
{
_projectDefinitionParser = serviceProvider.GetRequiredService<IProjectDefinitionParser>();
_fileManager = serviceProvider.GetRequiredService<IFileManager>();
_directoryManager = serviceProvider.GetRequiredService<IDirectoryManager>();
_deployToolCli = serviceProvider.GetRequiredService<CLI.App>();
}

/// <summary>
/// Generates Dockerfiles for test applications using
/// the <see href="https://github.com/aws/aws-dotnet-deploy/blob/main/src/AWS.Deploy.DockerEngine/Templates/Dockerfile.template">Dockerfile template</see>.
/// It will then build and push the images to Amazon ECR where they are continuously scanned for security vulnerabilities.
/// </summary>
public async Task Run()
{
foreach (var testApp in _testApps)
{
var projectPath = ResolvePath(testApp);
await CreateImageAndPushToECR(projectPath);
}
}

private async Task CreateImageAndPushToECR(string projectPath)
{
var projectDefinition = await _projectDefinitionParser.Parse(projectPath);

var dockerEngine = new DockerEngine.DockerEngine(projectDefinition, _fileManager, _directoryManager);
dockerEngine.GenerateDockerFile();

var configFilePath = Path.Combine(projectPath, "DockerImageUploaderConfigFile.json");
var deployArgs = new[] { "deploy", "--project-path", projectPath, "--diagnostics", "--apply", configFilePath, "--silent" };
await _deployToolCli.Run(deployArgs);
}

private string ResolvePath(string projectName)
{
const string testDir = "test";
var testDirPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
while (testDirPath != null && !string.Equals(new DirectoryInfo(testDirPath).Name, testDir, StringComparison.OrdinalIgnoreCase))
{
testDirPath = Directory.GetParent(testDirPath)?.FullName;
}

if (string.IsNullOrEmpty(testDirPath))
{
throw new Exception($"Failed to find path to '{testDir}' directory.");
}

return Path.Combine(testDirPath, "..", "testapps", projectName);
}
}
}
37 changes: 37 additions & 0 deletions test/AWS.Deploy.DockerImageUploader/Program.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

using Microsoft.Extensions.DependencyInjection;
using AWS.Deploy.CLI.Extensions;
using System.Threading.Tasks;
using System;

namespace AWS.Deploy.DockerImageUploader
{
/// <summary>
/// This console app generates a docker file for a .NET console application and a web application via
/// the <see href="https://github.com/aws/aws-dotnet-deploy/blob/main/src/AWS.Deploy.DockerEngine/Templates/Dockerfile.template">Dockerfile template</see>.
/// It will then build and push the images to Amazon ECR where they are continuously scanned for security vulnerabilities.
/// </summary>
internal class Program
{
public static async Task Main(string[] args)
{
var serviceCollection = new ServiceCollection();

serviceCollection.AddCustomServices();
serviceCollection.AddSingleton<App>();

var serviceProvider = serviceCollection.BuildServiceProvider();

var app = serviceProvider.GetService<App>();
if (app == null)
{
throw new Exception("App dependencies aren't injected correctly." +
" Verify that all the required dependencies to instantiate DockerImageUploader are present.");
}

await app.Run();
}
}
}
7 changes: 7 additions & 0 deletions testapps/ConsoleAppTask/DockerImageUploaderConfigFile.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"RecipeId": "PushContainerImageEcr",
"settings": {
"ImageTag": "latest",
"ECRRepositoryName": "deploytool-consoleapp"
}
}
7 changes: 7 additions & 0 deletions testapps/WebApiNET6/DockerImageUploaderConfigFile.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"RecipeId": "PushContainerImageEcr",
"settings": {
"ImageTag": "latest",
"ECRRepositoryName": "deploytool-webapp"
}
}