(#219) Add support for new codecov uploader

Source/Cake.Codecov.Tests/CodecovRunnerTests.cs

@@ -1,10 +1,10 @@
+using System;
 using Cake.Codecov.Internals;
 using Cake.Codecov.Tests.Attributes;
 using Cake.Core;
 using Cake.Testing;
 using FluentAssertions;
 using Moq;
-using System;
 using Xunit;
 
 namespace Cake.Codecov.Tests

Source/Cake.Codecov/CodecovCommonSettings.cs

@@ -0,0 +1,234 @@
+// <copyright file="CodecovCommonSettings.cs" company="Cake Contrib">
+// Copyright (c) 2017-2021 Larz White, Kim J. Nordmo and Cake Contrib.
+// Licensed under the MIT license. See LICENSE in the project.
+// </copyright>
+
+using System;
+using System.Collections.Generic;
+
+using Cake.Core.Tooling;
+
+namespace Cake.Codecov
+{
+    /// <summary>
+    /// Common codebase for settings that can be used to support different Codecov Uploaders.
+    /// </summary>
+    public abstract class CodecovCommonSettings : ToolSettings
+    {
+        private readonly IDictionary<string, object> _arguments = new Dictionary<string, object>();
+
+        /// <summary>
+        /// Gets or sets a property specifing the branch name.
+        /// </summary>
+        /// <value>A property specifing the branch name.</value>
+        public string Branch
+        {
+            get => GetValue<string>("--branch");
+            set => SetValue("--branch", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a property specifing the build number.
+        /// </summary>
+        /// <value>A property specifing the build number.</value>
+        public string Build
+        {
+            get => GetValue<string>("--build");
+            set => SetValue("--build", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a property specifing the commit sha.
+        /// </summary>
+        /// <value>A property specifing the commit sha.</value>
+        public string Commit
+        {
+            get => GetValue<string>("--sha");
+            set => SetValue("--sha", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the enviornment variables to be included with this build.
+        /// (1) CODECOV_ENV=VAR1,VAR2. (2) -e VAR1 VAR2.
+        /// </summary>
+        /// <value>
+        /// A value specifing the enviornment variables to be included with this build. (1)
+        /// CODECOV_ENV=VAR1,VAR2. (2) -e VAR1 VAR2.
+        /// </value>
+        public IEnumerable<string> Envs
+        {
+            get => GetValue<IEnumerable<string>>("--env");
+            set => SetValue("--env", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifying which flags should be toggled on/off.
+        /// </summary>
+        /// <value>A value specifying which features should be toggled on or off.</value>
+        public IEnumerable<string> Features
+        {
+            get => GetValue<IEnumerable<string>>("--feature");
+            set => SetValue("--feature", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the target file(s) to upload. (1) -f 'path/to/file'. Only
+        /// upload this file. (2) -f 'path/to/file1 path/to/file2'. Only upload these files.
+        /// </summary>
+        /// <value>
+        /// A value specifing the target file(s) to upload. (1) -f 'path/to/file'. Only upload this
+        /// file. (2) -f 'path/to/file1 path/to/file2'. Only upload these files.
+        /// </value>
+        /// <remarks>Globbing in file paths are supported, but not when path starts with './'.</remarks>
+        public IEnumerable<string> Files
+        {
+            get => GetValue<IEnumerable<string>>("--file");
+            set => SetValue("--file", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the flag the upload to group coverage metrics. (1) --flag
+        /// unittests. This upload is only unittests. (2) --flag integration. This upload is only
+        /// integration tests. (3) --flag ut,chrome. This upload is chrome - UI tests.
+        /// </summary>
+        /// <value>
+        /// A value specifing the flag the upload to group coverage metrics. (1) --flag unittests.
+        /// This upload is only unittests. (2) --flag integration. This upload is only integration
+        /// tests. (3) --flag ut,chrome. This upload is chrome - UI tests.
+        /// </value>
+        public string Flags
+        {
+            get => GetValue<string>("--flag");
+            set => SetValue("--flag", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the custom defined name of the upload. Visible in Codecov UI.
+        /// </summary>
+        /// <value>
+        /// A value specifing the custom defined name of the upload. Visible in Codecov UI.
+        /// </value>
+        public string Name
+        {
+            get => GetValue<string>("--name");
+            set => SetValue("--name", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the pull request number.
+        /// </summary>
+        /// <value>A value specifing the pull request number.</value>
+        public string Pr
+        {
+            get => GetValue<string>("--pr");
+            set => SetValue("--pr", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the owner/repo slug used instead of the private repo
+        /// token in Enterprise. (option) Set environment variable CODECOV_SLUG=:owner/:repo.
+        /// </summary>
+        /// <value>
+        /// A value specifing the owner/repo slug used instead of the private repo token in
+        /// Enterprise. (option) Set environment variable CODECOV_SLUG=:owner/:repo.
+        /// </value>
+        public string Slug
+        {
+            get => GetValue<string>("--slug");
+            set => SetValue("--slug", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the git tag.
+        /// </summary>
+        /// <value>A value specifing the git tag.</value>
+        public string Tag
+        {
+            get => GetValue<string>("--tag");
+            set => SetValue("--tag", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the private repository token. (option) set the
+        /// enviornment variable CODECOV_TOKEN-uuid. (1) -t @/path/to/token_file. (2) -t uuid.
+        /// </summary>
+        /// <value>
+        /// A value specifing the private repository token. (option) set the enviornment variable
+        /// CODECOV_TOKEN-uuid. (1) -t @/path/to/token_file. (2) -t uuid.
+        /// </value>
+        public string Token
+        {
+            get => GetValue<string>("!--token");
+            set => SetValue("!--token", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value specifing the target url for Enterprise customers. (option) Set
+        /// environment variable CODECOV_URL=https://my-hosted-codecov.com.
+        /// </summary>
+        /// <value>
+        /// A value specifing the target url for Enterprise customers. (option) Set environment
+        /// variable CODECOV_URL=https://my-hosted-codecov.com.
+        /// </value>
+        public Uri Url
+        {
+            get => GetValue<Uri>("--url");
+            set => SetValue("--url", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to run in verbose mode.
+        /// </summary>
+        /// <value>A value indicating whether to run in verbose mode.</value>
+        public bool Verbose
+        {
+            get => GetValue<bool>("--verbose");
+            set => SetValue("--verbose", value);
+        }
+
+        internal IDictionary<string, object> GetAllArguments()
+            => _arguments;
+
+        /// <summary>
+        /// Gets a value that is already set in the underlying dictionary. If no value is set, then
+        /// <paramref name="defaultValue"/> is returned instead.
+        /// </summary>
+        /// <typeparam name="TValue">The type of the value expected in the dictionary.</typeparam>
+        /// <param name="key">The key or name of the value.</param>
+        /// <param name="defaultValue">The default value if no value is found.</param>
+        /// <returns>
+        /// The found value with the specified <paramref name="key"/>, or the <paramref
+        /// name="defaultValue"/> is no value is found.
+        /// </returns>
+        protected TValue GetValue<TValue>(string key, TValue defaultValue = default)
+        {
+            if (_arguments.TryGetValue(key, out var objValue) && objValue is TValue value)
+            {
+                return value;
+            }
+
+            return defaultValue;
+        }
+
+        /// <summary>
+        /// Sets the specified <paramref name="value"/> in the underlying dictionary using the
+        /// specified <paramref name="key"/>.
+        /// </summary>
+        /// <param name="key">The key to use when adding/updating the dictionary.</param>
+        /// <param name="value">The value to insert.</param>
+        protected void SetValue(string key, object value)
+        {
+            if (value is string stringValue && string.IsNullOrWhiteSpace(stringValue))
+            {
+                if (_arguments.ContainsKey(key))
+                {
+                    _arguments.Remove(key);
+                }
+
+                return;
+            }
+
+            _arguments[key] = value;
+        }
+    }
+}

Source/Cake.Codecov/CodecovNewSettings.cs

@@ -0,0 +1,104 @@
+// <copyright file="CodecovNewSettings.cs" company="Cake Contrib">
+// Copyright (c) 2017-2021 Larz White, Kim J. Nordmo and Cake Contrib.
+// Licensed under the MIT license. See LICENSE in the project.
+// </copyright>
+
+using System.IO;
+
+namespace Cake.Codecov
+{
+    /// <summary>
+    /// Contains settings used by <see cref="CodecovRunner"/> for the new Codecov Uploader provided
+    /// by their team.
+    /// </summary>
+    /// <seealso cref="CodecovCommonSettings"/>
+    /// <remarks>This will be the default in v2.0.0 and legacy support will be dropped.</remarks>
+    public sealed class CodecovNewSettings : CodecovCommonSettings
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether Discovered coverage reports should be moved to
+        /// the trash.
+        /// </summary>
+        /// <value>
+        /// A value indicating whether Discovered coverage reports should be moved to the trash.
+        /// </value>
+        public bool CleanReports
+        {
+            get => GetValue<bool>("--clean");
+            set => SetValue("--clean", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether files should be uploaded to Codecov.
+        /// </summary>
+        /// <value>A value indicating whether files should be uploaded to Codecov.</value>
+        public bool DryRun
+        {
+            get => GetValue<bool>("--dryRun");
+            set => SetValue("--dryRun", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether Codecov should run with gcov support or not.
+        /// </summary>
+        /// <value>A value indicating whether Codecov should run with gcov support or not.</value>
+        public bool EnableGcovSupport
+        {
+            get => GetValue<bool>("--gcov");
+            set => SetValue("--gcov", value);
+        }
+
+        /// <summary>
+        /// Gets or sets the commit SHA of the parent for which you are uploading coverage. If not
+        /// set, the parent will be determined using the API of your repository provider. When using
+        /// the repository provider's API, the parent is determined via finding the closest ancestor
+        /// of the commit.
+        /// </summary>
+        /// <value>The commit SHA of the parent for which you are uploading coverage.</value>
+        public string ParentSha
+        {
+            get => GetValue<string>("--parent");
+            set => SetValue("--parent", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether Codecov should exit with a non-zero exit code on errors.
+        /// </summary>
+        /// <value>Whether Codecov should exit with a non-zero exit code on errors.</value>
+        public bool Required
+        {
+            get => GetValue<bool>("--nonZero");
+            set => SetValue("--nonZero", value);
+        }
+
+        /// <summary>
+        /// Gets or sets the root directory when it is not a git repository.
+        /// </summary>
+        /// <value>The root directory when it is not a git repository.</value>
+        public DirectoryInfo RootDirectory
+        {
+            get => GetValue<DirectoryInfo>("--rootDir");
+            set => SetValue("--rootDir", value);
+        }
+
+        /// <summary>
+        /// Gets or sets the directory to use when searching for coverage reports.
+        /// </summary>
+        /// <value>The directory to use when searching for coverage reports.</value>
+        public DirectoryInfo SearchDirectory
+        {
+            get => GetValue<DirectoryInfo>("--dir");
+            set => SetValue("--dir", value);
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the a link should be displayed to the current changelog.
+        /// </summary>
+        /// <value>A value indicating whether a link should be showed to the changelog.</value>
+        public bool ShowChangelog
+        {
+            get => GetValue<bool>("--changelog");
+            set => SetValue("--changelog", value);
+        }
+    }
+}

Source/Cake.Codecov/CodecovRunner.cs

@@ -43,11 +43,13 @@ protected override IEnumerable<string> GetToolExecutableNames()
         {
             if (_platformDetector.IsLinuxPlatform())
             {
+                yield return "codecov-linux";
                 yield return "linux-x64/codecov";
                 yield return "codecov";
             }
             else if (_platformDetector.IsOsxPlatform())
             {
+                yield return "codecov-macos";
                 yield return "osx-x64/codecov";
                 yield return "codecov";
             }