Micro-batching for logs sending, restricted access to internal classe…

…s, no op registrar implementation
zebrunner · Apr 14, 2021 · 51478a1 · 51478a1
1 parent 2961933
commit 51478a1
Show file tree

Hide file tree

Showing 34 changed files with 424 additions and 142 deletions.
diff --git a/Client/Requests/ArtifactReference.cs b/Client/Requests/ArtifactReference.cs
@@ -1,6 +1,6 @@
 namespace ZafiraIntegration.Client.Requests
 {
-    public class ArtifactReference
+    internal class ArtifactReference
     {
         public string Name { get; }
         public string Value { get; }

diff --git a/Client/Requests/FinishTestRequest.cs b/Client/Requests/FinishTestRequest.cs
@@ -2,7 +2,7 @@
 
 namespace ZafiraIntegration.Client.Requests
 {
-    public class FinishTestRequest
+    internal class FinishTestRequest
     {
         public DateTime EndedAt { get; set; }
         public string Result { get; set; }

diff --git a/Client/Requests/FinishTestRunRequest.cs b/Client/Requests/FinishTestRunRequest.cs
@@ -2,7 +2,7 @@
 
 namespace ZafiraIntegration.Client.Requests
 {
-    public class FinishTestRunRequest
+    internal class FinishTestRunRequest
     {
         public DateTime EndedAt { get; set; }
     }

diff --git a/Client/Requests/Label.cs b/Client/Requests/Label.cs
@@ -1,11 +1,11 @@
 namespace ZafiraIntegration.Client.Requests
 {
-    public class Label
+    internal class Label
     {
         public string Key { get; }
         public string Value { get; }
 
-        public Label(string key, string value)
+        internal Label(string key, string value)
         {
             Key = key;
             Value = value;

diff --git a/Client/Requests/Log.cs b/Client/Requests/Log.cs
@@ -1,6 +1,6 @@
 namespace ZafiraIntegration.Client.Requests
 {
-    public class Log
+    internal class Log
     {
         public long TestId { get; set; }
         public string Message { get; set; }

diff --git a/Client/Requests/RefreshAccessTokenRequest.cs b/Client/Requests/RefreshAccessTokenRequest.cs
@@ -1,6 +1,6 @@
 namespace ZafiraIntegration.Client.Requests
 {
-    public class RefreshAccessTokenRequest
+    internal class RefreshAccessTokenRequest
     {
         public string RefreshToken { get; set; }
     }

diff --git a/Client/Requests/StartTestRequest.cs b/Client/Requests/StartTestRequest.cs
@@ -1,8 +1,9 @@
 using System;
+using System.Collections.Generic;
 
 namespace ZafiraIntegration.Client.Requests
 {
-    public class StartTestRequest
+    internal class StartTestRequest
     {
         public string Name { get; set; }
         public string CorrelationData { get; set; }
@@ -11,5 +12,6 @@ public class StartTestRequest
         public DateTime StartedAt { get; set; }
         public string Maintainer { get; set; }
         public string TestCase { get; set; }
+        public List<Label> Labels { get; set; }
     }
 }
diff --git a/Client/Requests/StartTestRunRequest.cs b/Client/Requests/StartTestRunRequest.cs
@@ -2,7 +2,7 @@
 
 namespace ZafiraIntegration.Client.Requests
 {
-    public class StartTestRunRequest
+    internal class StartTestRunRequest
     {
         public string Uuid { get; set; }
         public string Name { get; set; }
@@ -11,13 +11,13 @@ public class StartTestRunRequest
         public ConfigDto Config { get; set; }
         public JenkinsContextDto JenkinsContext { get; set; }
 
-        public class ConfigDto
+        internal class ConfigDto
         {
             public string Environment { get; set; }
             public string Build { get; set; }
         }
 
-        public class JenkinsContextDto
+        internal class JenkinsContextDto
         {
             public string JobUrl { get; set; }
             public string JobNumber { get; set; }

diff --git a/Client/Responses/RefreshAccessTokenResponse.cs b/Client/Responses/RefreshAccessTokenResponse.cs
@@ -1,6 +1,6 @@
 namespace ZafiraIntegration.Client.Responses
 {
-    public class RefreshAccessTokenResponse
+    internal class RefreshAccessTokenResponse
     {
         public string AuthToken { get; set; }
     }

diff --git a/Client/Responses/SaveTestResponse.cs b/Client/Responses/SaveTestResponse.cs
@@ -2,7 +2,7 @@
 
 namespace ZafiraIntegration.Client.Responses
 {
-    public class SaveTestResponse
+    internal class SaveTestResponse
     {
         public long Id { get; set; }
         public string Name { get; set; }

diff --git a/Client/Responses/SaveTestRunResponse.cs b/Client/Responses/SaveTestRunResponse.cs
@@ -2,7 +2,7 @@
 
 namespace ZafiraIntegration.Client.Responses
 {
-    public class SaveTestRunResponse
+    internal class SaveTestRunResponse
     {
         public long Id { get; set; }
         public string Uuid { get; set; }
@@ -13,7 +13,7 @@ public class SaveTestRunResponse
         public string Framework { get; set; }
         public ConfigDto Config { get; set; }
 
-        public class ConfigDto
+        internal class ConfigDto
         {
             public string Environment { get; set; }
             public string Build { get; set; }

diff --git a/Client/ZebrunnerApiClient.cs b/Client/ZebrunnerApiClient.cs
@@ -14,13 +14,13 @@
 
 namespace ZafiraIntegration.Client
 {
-    public class ZebrunnerApiClient
+    internal class ZebrunnerApiClient
     {
         internal static ZebrunnerApiClient Instance { get; } = new ZebrunnerApiClient();
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
         private readonly RestClient _restClient;
-        private readonly string authenticationToken;
+        private readonly string _authenticationToken;
 
         private ZebrunnerApiClient()
         {
@@ -33,7 +33,7 @@ private ZebrunnerApiClient()
 
             var response = _restClient.Post<RefreshAccessTokenResponse>(request);
             _restClient.Authenticator = new JwtAuthenticator(response.Data.AuthToken);
-            this.authenticationToken = response.Data.AuthToken;
+            _authenticationToken = response.Data.AuthToken;
         }
 
         private static string Iam(string resourceUri)
@@ -99,7 +99,7 @@ public void UploadScreenshot(long testRunId, long testId, byte[] bytes, DateTime
         {
             var httpClient = new HttpClient {BaseAddress = new Uri(Configuration.GetServerHost())};
             httpClient.DefaultRequestHeaders.Authorization =
-                new AuthenticationHeaderValue("Bearer", authenticationToken);
+                new AuthenticationHeaderValue("Bearer", _authenticationToken);
 
             var httpContent = new ByteArrayContent(bytes);
             httpContent.Headers.ContentType = new MediaTypeHeaderValue("image/png");

diff --git a/Config/Configuration.cs b/Config/Configuration.cs
@@ -1,42 +1,54 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using ZafiraIntegration.Config.Provider;
 
 namespace ZafiraIntegration.Config
 {
-    public static class Configuration
+    internal static class Configuration
     {
         private static readonly List<IConfigurationProvider> ConfigurationProviders = new List<IConfigurationProvider>
         {
             new EnvironmentVariablesConfigurationProvider()
         };
 
-        public static bool IsReportingEnabled()
+        internal static bool IsReportingEnabled()
         {
             return ConfigurationProviders
                 .Select(provider => provider.IsReportingEnabled())
-                .First(isReportingEnabled => isReportingEnabled);
+                .FirstOrDefault(isReportingEnabled => isReportingEnabled);
         }
 
-        public static string GetServerHost()
+        internal static string GetServerHost()
         {
-            return ConfigurationProviders
-                .Select(provider => provider.GetServerHost())
-                .First(serverHost => serverHost != null && serverHost.Trim().Length != 0);
+            return GetStringProperty(provider => provider.GetServerHost());
         }
 
-        public static string GetAccessToken()
+        internal static string GetAccessToken()
         {
-            return ConfigurationProviders
-                .Select(provider => provider.GetAccessToken())
-                .First(accessToken => accessToken != null && accessToken.Trim().Length != 0);
+            return GetStringProperty(provider => provider.GetAccessToken());
+        }
+
+        internal static string GetProjectKey()
+        {
+            return GetStringProperty(provider => provider.GetProjectKey());
+        }
+
+        internal static string GetEnvironment()
+        {
+            return GetStringProperty(provider => provider.GetEnvironment());
+        }
+
+        internal static string GetBuild()
+        {
+            return GetStringProperty(provider => provider.GetBuild());
         }
 
-        public static string GetProjectKey()
+        private static string GetStringProperty(Func<IConfigurationProvider, string> propertyResolver)
         {
             return ConfigurationProviders
-                .Select(provider => provider.GetProjectKey())
-                .First(projectKey => projectKey != null && projectKey.Trim().Length != 0);
+                .Select(propertyResolver)
+                .FirstOrDefault(property => property != null && property.Trim().Length != 0);
         }
     }
 }
diff --git a/Config/ConfigurationProvider.cs b/Config/ConfigurationProvider.cs
@@ -1,6 +1,6 @@
 namespace ZafiraIntegration.Config
 {
-    public interface IConfigurationProvider
+    internal interface IConfigurationProvider
     {
         bool IsReportingEnabled();
 
@@ -9,5 +9,9 @@ public interface IConfigurationProvider
         string GetAccessToken();
 
         string GetProjectKey();
+
+        string GetEnvironment();
+
+        string GetBuild();
     }
 }
diff --git a/Config/Provider/EnvironmentVariablesConfigurationProvider.cs b/Config/Provider/EnvironmentVariablesConfigurationProvider.cs
@@ -0,0 +1,56 @@
+using System;
+
+namespace ZafiraIntegration.Config.Provider
+{
+    internal class EnvironmentVariablesConfigurationProvider : IConfigurationProvider
+    {
+        private const string ReportingEnabledLegacyEnvironmentVariable = "zafira_enabled";
+        private const string ReportingEnabledEnvironmentVariable = "REPORTING_ENABLED";
+        private const string ServerHostLegacyEnvironmentVariable = "zafira_service_url";
+        private const string ServerHostEnvironmentVariable = "REPORTING_SERVER_HOSTNAME";
+        private const string AccessTokenLegacyEnvironmentVariable = "zafira_access_token";
+        private const string AccessTokenEnvironmentVariable = "REPORTING_SERVER_ACCESS_TOKEN";
+        private const string ProjectKeyLegacyEnvironmentVariable = "zafira_project";
+        private const string ProjectKeyEnvironmentVariable = "REPORTING_PROJECT_KEY";
+        private const string EnvironmentEnvironmentVariable = "REPORTING_RUN_ENVIRONMENT";
+        private const string BuildEnvironmentVariable = "REPORTING_RUN_BUILD";
+
+        private const string DefaultProjectKey = "UNKNOWN";
+
+        public bool IsReportingEnabled()
+        {
+            var reportingEnabled = Environment.GetEnvironmentVariable(ReportingEnabledLegacyEnvironmentVariable)
+                                   ?? Environment.GetEnvironmentVariable(ReportingEnabledEnvironmentVariable);
+            return string.Compare("true", reportingEnabled, StringComparison.OrdinalIgnoreCase) == 0;
+        }
+
+        public string GetServerHost()
+        {
+            return Environment.GetEnvironmentVariable(ServerHostLegacyEnvironmentVariable)
+                   ?? Environment.GetEnvironmentVariable(ServerHostEnvironmentVariable);
+        }
+
+        public string GetAccessToken()
+        {
+            return Environment.GetEnvironmentVariable(AccessTokenLegacyEnvironmentVariable)
+                   ?? Environment.GetEnvironmentVariable(AccessTokenEnvironmentVariable);
+        }
+
+        public string GetProjectKey()
+        {
+            return Environment.GetEnvironmentVariable(ProjectKeyLegacyEnvironmentVariable)
+                   ?? Environment.GetEnvironmentVariable(ProjectKeyEnvironmentVariable)
+                   ?? DefaultProjectKey;
+        }
+
+        public string GetEnvironment()
+        {
+            return Environment.GetEnvironmentVariable(EnvironmentEnvironmentVariable);
+        }
+
+        public string GetBuild()
+        {
+            return Environment.GetEnvironmentVariable(BuildEnvironmentVariable);
+        }
+    }
+}
diff --git a/Config/provider/EnvironmentVariablesConfigurationProvider.cs b/Config/provider/EnvironmentVariablesConfigurationProvider.cs