Release/1.0.0 (#186)

* fix bug local map URL

* better diagnostic

* Aggregator_AzureDevOpsCertificate to trust from container

* fix some issues with API key

.dockerignore

@@ -6,6 +6,10 @@
 **/.vscode
 **/*.zip
 docker/
+!docker/*.exe
+!docker/*.cmd
+!docker/*.sh
+!docker/*.pem
 outputs/
 marketplace/
 src/.build-trigger

.gitignore

@@ -348,6 +348,7 @@ src/aggregator-function/test*/*
 src/aggregator-cli/FunctionRuntime.zip
 .DS_Store
 *.exe
+!docker/certoc.exe
 *.diagsession
 *.vsix
 *.rdp

Next-Release-ChangeLog.md

@@ -1,25 +1,29 @@
-This is the final **Release Candidate** version.
+This is the inital **1.0** release.
 
 CLI Commands and Options
 ========================
 * Resolve code analysis warnings.
 * Fix incorrect HTTP Header in web hook Subscriptions made by `map.local.rule`.
+* Fix incorrect URL in web hook Subscriptions made by `map.local.rule`.
 
 
 Docker and Azure Function Hosting
 ========================
 * Resolve code analysis warnings.
-* Fix error CS1705
+* Fix CS1705 error.
+* Support for `Aggregator_AzureDevOpsCertificate` when Azure DevOps is using a certificate issued by non-trusted Certification Authority (e.g.self-signed).
+* Better handling of API keys.
 
 
 Rule Language
 ========================
-* optional `events` directive
+* New optional `events` directive.
 
 
 Rule Interpreter Engine
 ========================
 * Resolve code analysis warnings.
+* Improved some messages.
 
 
 Build, Test, Documentation
@@ -29,6 +33,9 @@ Build, Test, Documentation
 * Resolve code analysis warnings.
 * Fix default branch reference in CI workflow.
 * Push docker images to GitHub Container Registry (beta) in addition to Docker Hub.
+* Local version number is now `0.0.1-localdev`.
+* Fix build badge, added SonarQube badge.
+* Trimmed `.dockerignore`.
 
 
 File Hashes

docker/linux-x64.Dockerfile

@@ -37,7 +37,12 @@ ENV Aggregator_ApiKeysPath=/secrets/apikeys.json
 ENV Logging__LogLevel__Aggregator=Debug
 ENV ASPNETCORE_URLS=https://*:5320
 ENV AGGREGATOR_TELEMETRY_DISABLED=false
+ENV Aggregator_AzureDevOpsCertificate=
 
 EXPOSE 5320/tcp
 
-ENTRYPOINT [ "dotnet", "aggregator-host.dll" ]
+COPY ./docker/start.sh /app/start.sh
+RUN chmod +x /app/start.sh
+
+ENTRYPOINT /app/start.sh
+#ENTRYPOINT [ "dotnet", "aggregator-host.dll" ]

docker/start.cmd

@@ -0,0 +1,21 @@
+@ECHO OFF
+
+REM Bypass "Terminate Batch Job" prompt.
+if "%~1"=="-FIXED_CTRL_C" (
+   REM Remove the -FIXED_CTRL_C parameter
+   SHIFT
+) ELSE (
+   REM Run the batch with <NUL and -FIXED_CTRL_C
+   CALL <NUL %0 -FIXED_CTRL_C %*
+   GOTO :EOF
+)
+
+IF EXIST "%Aggregator_AzureDevOpsCertificate%" (
+    ECHO Importing %Aggregator_AzureDevOpsCertificate%
+    certoc -addstore root "%Aggregator_AzureDevOpsCertificate%"
+    ECHO Import completed
+    ECHO.
+)
+dotnet aggregator-host.dll
+
+EXIT

docker/start.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+if [ -f "/secrets/$Aggregator_AzureDevOpsCertificate" ]; then
+    echo Importing $Aggregator_AzureDevOpsCertificate
+    #mkdir /usr/local/share/ca-certificates/extra
+    #cp /secrets/$Aggregator_AzureDevOpsCertificate /usr/local/share/ca-certificates/extra
+    cp /secrets/$Aggregator_AzureDevOpsCertificate /usr/local/share/ca-certificates/$Aggregator_AzureDevOpsCertificate
+    update-ca-certificates
+    echo Import completed
+fi
+dotnet aggregator-host.dll

docker/win-x64.Dockerfile

@@ -38,6 +38,7 @@ VOLUME c:/secrets
 ENV Aggregator_VstsTokenType=PAT
 ENV Aggregator_VstsToken=
 ENV Aggregator_RulesPath=c:\rules
+ENV Aggregator_AzureDevOpsCertificate=
 ENV ASPNETCORE_Kestrel__Certificates__Default__Path=c:\secrets\aggregator.pfx
 ENV Aggregator_ApiKeysPath=c:\secrets\apikeys.json
 ENV Logging__LogLevel__Aggregator=Debug
@@ -49,5 +50,8 @@ EXPOSE 5320/tcp
 # https://github.com/dotnet/dotnet-docker/issues/915
 USER ContainerAdministrator
 
-ENTRYPOINT [ "dotnet", "aggregator-host.dll" ]
+COPY ./docker/certoc.exe .
+COPY ./docker/start.cmd .
+
+ENTRYPOINT [ "start.cmd" ]
 

src/aggregator-cli/Instances/FunctionRuntimePackage.cs

@@ -51,10 +51,10 @@ internal FunctionRuntimePackage(ILogger logger)
 
             if (gitHubVersion == null || string.IsNullOrEmpty(gitHubVersion.Name))
             {
-                logger.WriteError($"Requested version does not exist.");
+                logger.WriteError($"Requested CLI version does not exist in GitHub.");
                 return (upgrade: false, newversion: "");
             }
-            logger.WriteVerbose($"Found {gitHubVersion.Name} on {gitHubVersion.When} in GitHub .");
+            logger.WriteVerbose($"Found {gitHubVersion.Name} on {gitHubVersion.When} in GitHub.");
 
             SemVersion.TryParse(gitHubVersion.Name.Substring(1), out var latest);
             var current = new SemVersion(
@@ -260,7 +260,7 @@ string GitHubTagFromUserVersion(string requiredVersion)
 
             if (gitHubVersion == null || string.IsNullOrEmpty(gitHubVersion.Name))
             {
-                logger.WriteError($"Requested runtime {requiredVersion} version does not exist.");
+                logger.WriteError($"Requested runtime {requiredVersion} version does not exist in GitHub.");
                 return (null, null);
             }
             logger.WriteVerbose($"Found {gitHubVersion.Name} on {gitHubVersion.When} in GitHub .");
@@ -289,7 +289,7 @@ internal async Task<SemVersion> GetDeployedRuntimeVersion(InstanceName instance,
                 }
                 else
                 {
-                    logger.WriteWarning($"Cannot read aggregator-manifest.ini: {response.ReasonPhrase}");
+                    logger.WriteWarning($"Cannot read aggregator-manifest.ini: {response.ReasonPhrase} (disregard this message on new instances)");
                     uploadedRuntimeVer = new SemVersion(0, 0, 0);
                 }
             }

src/aggregator-cli/Mappings/AggregatorMappings.cs

@@ -91,11 +91,15 @@ internal async Task<Guid> AddFromUrlAsync(string projectName, string @event, Eve
         {
             async Task<(Uri, string)> RetrieveHostedUrl(string _ruleName, CancellationToken _cancellationToken)
             {
-                string apiKey = "INVALID";
+                string apiKey = MagicConstants.InvalidApiKey;
 
                 logger.WriteVerbose($"Validating target URL {targetUrl.AbsoluteUri}");
 
-                string userManagedPassword = Environment.GetEnvironmentVariable("Aggregator_SharedSecret");
+                string userManagedPassword = Environment.GetEnvironmentVariable(MagicConstants.EnvironmentVariable_SharedSecret);
+                if (string.IsNullOrEmpty(userManagedPassword))
+                {
+                    throw new ApplicationException($"{MagicConstants.EnvironmentVariable_SharedSecret} environment variable is required for this command");
+                }
 
                 string proof = SharedSecret.DeriveFromPassword(userManagedPassword);
 
@@ -115,7 +119,7 @@ internal async Task<Guid> AddFromUrlAsync(string projectName, string @event, Eve
                         switch (response.StatusCode)
                         {
                             case HttpStatusCode.OK:
-                                logger.WriteVerbose($"Connected to {targetUrl}");
+                                logger.WriteVerbose($"Connection to {targetUrl} succeded");
                                 apiKey = await response.Content.ReadAsStringAsync();
                                 logger.WriteInfo($"Configuration retrieved.");
                                 break;
@@ -127,10 +131,13 @@ internal async Task<Guid> AddFromUrlAsync(string projectName, string @event, Eve
                     }
                 }
 
-                logger.WriteInfo($"Target URL is working");
+                if (string.IsNullOrEmpty(apiKey) || apiKey == MagicConstants.InvalidApiKey)
+                {
+                    throw new ApplicationException("Unable to retrieve API Key, please check Shared secret configuration");
+                }
 
                 var b = new UriBuilder(targetUrl);
-                b.Path += $"/workitem/{_ruleName}";
+                b.Path += $"workitem/{_ruleName}";
                 return (b.Uri, apiKey);
             }
 

src/aggregator-host/Controllers/ConfigController.cs

@@ -1,4 +1,5 @@
-using System.Text.Json;
+using System;
+using System.Text.Json;
 using aggregator;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
@@ -48,15 +49,22 @@ public string RetrieveKey([FromBody] JsonElement body)
             _log.LogDebug("RetrieveKey method was called!");
 
             string proof = body.GetString();
-            string userManagedPassword = _configuration.GetValue<string>("Aggregator_SharedSecret");
+            string userManagedPassword = _configuration.GetValue<string>(MagicConstants.EnvironmentVariable_SharedSecret);
+            if (string.IsNullOrEmpty(userManagedPassword))
+            {
+                throw new ApplicationException($"{MagicConstants.EnvironmentVariable_SharedSecret} environment variable is required by CLI");
+            }
 
             if (proof == SharedSecret.DeriveFromPassword(userManagedPassword))
             {
                 return _apiKeyRepo.PickValidKey();
             }
+            else
+            {
+                _log.LogError("API Key request failed from {0}", HttpContext.Connection.RemoteIpAddress);
+                return MagicConstants.InvalidApiKey;
 
-            return "OK";
-
+            }
         }
     }
 }

src/aggregator-ruleng/RuleExecutor.cs

@@ -40,8 +40,19 @@ private async Task<string> ExecAsyncImpl(IRule rule, WorkItemEventContext eventC
 
             // TODO improve from https://github.com/Microsoft/vsts-work-item-migrator
             using var devops = new VssConnection(eventContext.CollectionUri, clientCredentials);
-            await devops.ConnectAsync(cancellationToken);
-            logger.WriteInfo($"Connected to Azure DevOps");
+            try
+            {
+                await devops.ConnectAsync(cancellationToken);
+                logger.WriteInfo($"Connected to Azure DevOps");
+            }
+            catch (System.Exception ex)
+            {
+                logger.WriteError(ex.Message);
+                if (ex.InnerException != null) {
+                    logger.WriteError(ex.InnerException.Message);
+                }
+                throw ex;
+            }
             using var clientsContext = new AzureDevOpsClientsContext(devops);
             var engine = new RuleEngine(logger, configuration.SaveMode, configuration.DryRun);
 

src/aggregator-shared/MagicConstants.cs

@@ -4,8 +4,10 @@ public static class MagicConstants
     {
         public const string LoggerCategoryName = "Aggregator";
         public const string ApiKeyAuthenticationHeaderName = "X-Auth-ApiKey";
+        public const string InvalidApiKey = "INVALID";
 #pragma warning disable S1075 // URIs should not be hardcoded
         public const string MissingUrl = "https://this.should.never.come.up.example.com/";
 #pragma warning restore S1075 // URIs should not be hardcoded
+        public const string EnvironmentVariable_SharedSecret = "Aggregator_SharedSecret";
     }
 }