feat: Use new Codecov uploader

2026-02-11 04:41:38 +00:00 · 2021-06-24 10:50:37 -04:00
parent b215992d02
commit 635d4e88ad
21 changed files with 45214 additions and 3633 deletions
--- a/src/buildExec.test.ts
+++ b/src/buildExec.test.ts
@@ -1,6 +1,8 @@
-import buildExec from './buildExec';
-const github = require('@actions/github');
+import * as github from '@actions/github';

+import buildExec from './buildExec';
+
+/* eslint-disable  @typescript-eslint/no-var-requires */
 const {version} = require('../package.json');

 const context = github.context;
@@ -9,11 +11,8 @@ test('no arguments', () => {
  const {execArgs, failCi} = buildExec();

  const args = [
-    'codecov',
    '-n',
    '',
-    '-F',
-    '',
    '-Q',
    `github-action-${version}`,
  ];
@@ -26,38 +25,30 @@ test('no arguments', () => {

 test('all arguments', () => {
  const envs = {
-    'move_coverage_to_trash': 'true',
    'commit_parent': '83231650328f11695dfb754ca0f540516f188d27',
-    'aws_curl_args': '--timeout 1',
-    'codecov_curl_args': '--timeout 2',
+    'directory': 'coverage/',
+    'dry_run': 'true',
    'env_vars': 'OS,PYTHON',
    'fail_ci_if_error': 'true',
    'file': 'coverage.xml',
    'files': 'dir1/coverage.xml,dir2/coverage.xml',
-    'flags': 'test',
+    'flags': 'test,test2',
    'functionalities':
-      'gcov,coveragepy,fix,search,code,network,gcovout,html,recursesubs',
-    'gcov_args': '--timeout 3',
-    'gcov_root_dr': 'gcov_dir/',
-    'gcov_path_exclude': '**/exclude-dir/*.*',
-    'gcov_executable': 'gcov',
-    'gcov_path_include': '**/include-dir/*.*',
-    'gcov_prefix': 'demo',
+      'network',
+    'move_coverage_to_trash': 'true',
    'name': 'codecov',
-    'network_filter': 'dir1',
    'override_branch': 'thomasrockhu/test',
    'override_build': '1',
    'override_commit': '9caabca5474b49de74ef5667deabaf74cdacc244',
    'override_pr': '2',
    'override_tag': 'v1.2',
+    'path_to_write_report': 'codecov/',
    'root_dir': 'root/',
-    'directory': 'coverage/',
+    'slug': 'fakeOwner/fakeRepo',
    'token': 'd3859757-ab80-4664-924d-aef22fa7557b',
+    'url': 'https://codecov.enterprise.com',
    'verbose': 't',
    'working-directory': 'src',
-    'path_to_write_report': 'codecov/',
-    'xcode_derived_data': '~/Library/Developer/Xcode/DerivedData',
-    'xcode_package': 'MyApp',
  };

  for (const env of Object.keys(envs)) {
@@ -66,22 +57,18 @@ test('all arguments', () => {

  const {execArgs, failCi} = buildExec();
  expect(execArgs).toEqual([
-    'src/codecov',
    '-n',
    'codecov',
-    '-F',
-    'test',
    '-Q',
    `github-action-${version}`,
    '-c',
    '-N',
    '83231650328f11695dfb754ca0f540516f188d27',
-    '-A',
-    '--timeout 1',
-    '-U',
-    '--timeout 2',
+    '-d',
    '-e',
    'OS,PYTHON',
+    '-X',
+    'network',
    '-Z',
    '-f',
    'coverage.xml',
@@ -89,36 +76,10 @@ test('all arguments', () => {
    'dir1/coverage.xml',
    '-f',
    'dir2/coverage.xml',
-    '-X',
-    'gcov',
-    '-X',
-    'coveragepy',
-    '-X',
-    'fix',
-    '-X',
-    'search',
-    '-X',
-    'code',
-    '-X',
-    'network',
-    '-X',
-    'gcovout',
-    '-X',
-    'html',
-    '-X',
-    'recursesubs',
-    '-a',
-    '--timeout 3',
-    '-g',
-    '**/exclude-dir/*.*',
-    '-x',
-    'gcov',
-    '-G',
-    '**/include-dir/*.*',
-    '-k',
-    'demo',
-    '-i',
-    'dir1',
+    '-F',
+    'test',
+    '-F',
+    'test2',
    '-B',
    'thomasrockhu/test',
    '-b',
@@ -133,13 +94,11 @@ test('all arguments', () => {
    'root/',
    '-s',
    'coverage/',
+    '-r',
+    'fakeOwner/fakeRepo',
+    '-u',
+    'https://codecov.enterprise.com',
    '-v',
-    '-q',
-    'codecov/',
-    '-D',
-    '~/Library/Developer/Xcode/DerivedData',
-    '-J',
-    'MyApp',
  ]);
  expect(failCi).toBeTruthy();

--- a/src/buildExec.ts
+++ b/src/buildExec.ts
@@ -1,6 +1,7 @@
-const core = require('@actions/core');
-const github = require('@actions/github');
+import * as core from '@actions/core';
+import * as github from '@actions/github';

+/* eslint-disable  @typescript-eslint/no-var-requires */
 const {version} = require('../package.json');

 const context = github.context;
@@ -19,22 +20,14 @@ const isTrue = (variable) => {
 const buildExec = () => {
  const clean = core.getInput('move_coverage_to_trash');
  const commitParent = core.getInput('commit_parent');
-  const curlAwsArgs = core.getInput('aws_curl_args');
-  const curlCodecovArgs = core.getInput('codecov_curl_args');
  const envVars = core.getInput('env_vars');
+  const dryRun = isTrue(core.getInput('dry_run'));
  const failCi = isTrue(core.getInput('fail_ci_if_error'));
  const file = core.getInput('file');
  const files = core.getInput('files');
  const flags = core.getInput('flags');
  const functionalities = core.getInput('functionalities');
-  const gcovArgs = core.getInput('gcov_args');
-  const gcovDir = core.getInput('gcov_root_dir');
-  const gcovExclude = core.getInput('gcov_path_exclude');
-  const gcovExec = core.getInput('gcov_executable');
-  const gcovInclude = core.getInput('gcov_path_include');
-  const gcovPrefix = core.getInput('gcov_prefix');
  const name = core.getInput('name');
-  const networkFilter = core.getInput('network_filter');
  const overrideBranch = core.getInput('override_branch');
  const overrideBuild = core.getInput('override_build');
  const overrideCommit = core.getInput('override_commit');
@@ -42,22 +35,16 @@ const buildExec = () => {
  const overrideTag = core.getInput('override_tag');
  const rootDir = core.getInput('root_dir');
  const searchDir = core.getInput('directory');
+  const slug = core.getInput('slug');
  const token = core.getInput('token');
  const verbose = isTrue(core.getInput('verbose'));
+  const url = core.getInput('url');
  const workingDir = core.getInput('working-directory');
-  const writePath = core.getInput('path_to_write_report');
-  const xcodeDerivedData = core.getInput('xcode_derived_data');
-  const xcodePackage = core.getInput('xcode_package');

-  const filepath = workingDir ?
-    workingDir + '/codecov' : 'codecov';
-
-  const execArgs = [filepath];
+  const execArgs = [];
  execArgs.push(
      '-n',
      `${name}`,
-      '-F',
-      `${flags}`,
      '-Q',
      `github-action-${version}`,
  );
@@ -90,15 +77,17 @@ const buildExec = () => {
  if (commitParent) {
    execArgs.push('-N', `${commitParent}`);
  }
-  if (curlAwsArgs) {
-    execArgs.push('-A', `${curlAwsArgs}`);
-  }
-  if (curlCodecovArgs) {
-    execArgs.push('-U', `${curlCodecovArgs}`);
+  if (dryRun) {
+    execArgs.push('-d');
  }
  if (envVarsArg.length) {
    execArgs.push('-e', envVarsArg.join(','));
  }
+  if (functionalities) {
+    functionalities.split(',').forEach((f) => {
+      execArgs.push('-X', `${f}`);
+    });
+  }
  if (failCi) {
    execArgs.push('-Z');
  }
@@ -110,32 +99,11 @@ const buildExec = () => {
      execArgs.push('-f', `${f}`);
    });
  }
-  if (functionalities) {
-    functionalities.split(',').forEach((f) => {
-      execArgs.push('-X', `${f}`);
+  if (flags) {
+    flags.split(',').forEach((f) => {
+      execArgs.push('-F', `${f}`);
    });
  }
-  if (gcovArgs) {
-    execArgs.push('-a', `${gcovArgs}`);
-  }
-  if (gcovDir) {
-    execArgs.push('-p', `${gcovDir}`);
-  }
-  if (gcovExclude) {
-    execArgs.push('-g', `${gcovExclude}`);
-  }
-  if (gcovExec) {
-    execArgs.push('-x', `${gcovExec}`);
-  }
-  if (gcovInclude) {
-    execArgs.push('-G', `${gcovInclude}`);
-  }
-  if (gcovPrefix) {
-    execArgs.push('-k', `${gcovPrefix}`);
-  }
-  if (networkFilter) {
-    execArgs.push('-i', `${networkFilter}`);
-  }
  if (overrideBranch) {
    execArgs.push('-B', `${overrideBranch}`);
  }
@@ -166,21 +134,18 @@ const buildExec = () => {
  if (searchDir) {
    execArgs.push('-s', `${searchDir}`);
  }
+  if (slug) {
+    execArgs.push('-r', `${slug}`);
+  }
+  if (url) {
+    execArgs.push('-u', `${url}`);
+  }
  if (verbose) {
    execArgs.push('-v');
  }
  if (workingDir) {
    options.cwd = workingDir;
  }
-  if (writePath) {
-    execArgs.push('-q', `${writePath}`);
-  }
-  if (xcodeDerivedData) {
-    execArgs.push('-D', `${xcodeDerivedData}`);
-  }
-  if (xcodePackage) {
-    execArgs.push('-J', `${xcodePackage}`);
-  }

  return {execArgs, options, failCi};
 };
--- a/src/helpers.ts
+++ b/src/helpers.ts
@@ -0,0 +1,41 @@
+import * as core from '@actions/core';
+
+const PLATFORMS = ['alpine', 'linux', 'macos', 'windows'];
+
+const setFailure = (message: string, failCi: boolean): void => {
+    failCi ? core.setFailed(message) : core.warning(message);
+    if (failCi) {
+      process.exit();
+    }
+};
+
+const getUploaderName = (): string => {
+  if (isWindows()) {
+    return 'codecov.exe';
+  } else {
+    return 'codecov';
+  }
+};
+
+const isValidPlatform = (): boolean => {
+  return PLATFORMS.includes(getPlatform());
+};
+
+const isWindows = (): boolean => {
+  return getPlatform() === 'windows';
+};
+
+const getPlatform = (): string => {
+  return process.env.RUNNER_OS.toLowerCase();
+};
+
+const BASEURL = `https://uploader.codecov.io/latest/${getPlatform()}/${getUploaderName()}`;
+
+export {
+  BASEURL,
+  getPlatform,
+  getUploaderName,
+  isValidPlatform,
+  isWindows,
+  setFailure,
+};
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,17 +1,69 @@
-const core = require('@actions/core');
-const exec = require('@actions/exec');
+import * as fs from 'fs';
+import * as https from 'https';
+import * as path from 'path';
+
+import * as exec from '@actions/exec';

 import buildExec from './buildExec';
+import {
+  BASEURL,
+  getPlatform,
+  getUploaderName,
+  isValidPlatform,
+  setFailure,
+} from './helpers';

-const {execArgs, options, failCi} = buildExec();
+import verify from './validate';

-exec.exec('bash', execArgs, options)
-    .catch((err) => {
-      if (failCi) {
-        core.setFailed(
-            `Codecov failed with the following error: ${err.message}`,
-        );
-      } else {
-        core.warning(`Codecov warning: ${err.message}`);
-      }
-    });
+let failCi;
+
+try {
+  const {execArgs, options, failCi} = buildExec();
+  const platform = getPlatform();
+  if (!isValidPlatform()) {
+    setFailure(
+        `Codecov: Encountered an unexpected platform: ${platform}`,
+        failCi,
+    );
+  }
+  const filename = path.join( __dirname, getUploaderName());
+  https.get(BASEURL, (res) => {
+    // Image will be stored at this path
+    const filePath = fs.createWriteStream(filename);
+    res.pipe(filePath);
+    filePath
+        .on('error', (err) => {
+          setFailure(
+              `Codecov: Failed to write uploader binary: ${err.message}`,
+              true,
+          );
+        }).on('finish', async () => {
+          filePath.close();
+
+          await verify(filename);
+          await fs.chmodSync(filename, '777');
+
+          const unlink = () => {
+            fs.unlink(filename, (err) => {
+              if (err) {
+                setFailure(
+                    `Codecov: Could not unlink uploader: ${err.message}`,
+                    failCi,
+                );
+              }
+            });
+          };
+          await exec.exec(filename, execArgs, options)
+              .catch((err) => {
+                setFailure(
+                    `Codecov: Failed to properly upload: ${err.message}`,
+                    failCi,
+                );
+              }).then(() => {
+                unlink();
+              });
+        });
+  });
+} catch (err) {
+  setFailure(`Codecov: Encountered an unexpected error ${err.message}`, failCi);
+}
--- a/src/pgp_keys.asc
+++ b/src/pgp_keys.asc
@@ -0,0 +1,52 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBGCsMn0BEACiCKZOhkbhUjb+obvhH49p3ShjJzU5b/GqAXSDhRhdXUq7ZoGq
+KEKCd7sQHrCf16Pi5UVacGIyE9hS93HwY15kMlLwM+lNeAeCglEscOjpCly1qUIr
+sN1wjkd2cwDXS6zHBJTqJ7wSOiXbZfTAeKhd6DuLEpmA+Rz4Yc+4qZP+fVxVG3Pv
+2v06m+E5CP/JQVQPO8HYi+S36hJImTh+zaDspu+VujSai5KzJ6YKmgwslVNIp5X5
+GnEr2uAh5w6UTnt9UQUjFFliAvQ3lPLWzm7DWs6AP9hslYxSWzwbzVF5qbOIjUJL
+KfoUpvCYDs2ObgRn8WUQO0ndkRCBIxhlF3HGGYWKQaCEsiom7lyi8VbAszmUCDjw
+HdbQHFmm5yHLpTXJbg+iaxQzKnhWVXzye5/x92IJmJswW81Ky346VxYdC1XFL/+Y
+zBaj9oMmV7WfRpdch09Gf4TgosMzWf3NjJbtKE5xkaghJckIgxwzcrRmF/RmCJue
+IMqZ8A5qUUlK7NBzj51xmAQ4BtkUa2bcCBRV/vP+rk9wcBWz2LiaW+7Mwlfr/C/Q
+Swvv/JW2LsQ4iWc1BY7m7ksn9dcdypEq/1JbIzVLCRDG7pbMj9yLgYmhe5TtjOM3
+ygk25584EhXSgUA3MZw+DIqhbHQBYgrKndTr2N/wuBQY62zZg1YGQByD4QARAQAB
+tEpDb2RlY292IFVwbG9hZGVyIChDb2RlY292IFVwbG9hZGVyIFZlcmlmaWNhdGlv
+biBLZXkpIDxzZWN1cml0eUBjb2RlY292LmlvPokCTgQTAQoAOBYhBCcDTn/bhQ4L
+vCxi/4Brsortd5hpBQJgrDJ9AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheAAAoJ
+EIBrsortd5hpxLMP/3Fbgx5EG7zUUOqPZ+Ya9z8JlZFIkh3FxYMfMFE8jH9Es26F
+V2ZTJLO259MxM+5N0XzObi3h4XqIzBn42pDRfwtojY5wl2STJ9Bzu+ykPog7OB1u
+yfWXDRKcqPTUIxI1/WdU+c0/WNE6wjyzK+lRc1YUlp4pdNU7l+j2vKN+jGi2b6nV
+PTPRsMcwy3B90fKf5h2wNMNqO+KX/rjgpG9Uhej+xyFWkGM1tZDQQYFj+ugQUj61
+BMsQrUmxOnaVVnix21cHnACDCaxqgQZH3iZyEOKPNMsRFRP+0fLEnUMP+DVnQE6J
+Brk1Z+XhtjGI9PISQVx5KKDKscreS/D5ae2Cw/FUlQMf57kir6mkbZVhz2khtccz
+atD0r59WomNywIDyk1QfAKV0+O0WeJg8A69/Jk6yegsrUb5qEfkih/I38vvI0OVL
+BYve/mQIHuQo5ziBptNytCrN5TXHXzguX9GOW1V1+3DR+w/vXcnz67sjlYDysf1f
+JUZv9edZ2RGKW7agbrgOw2hB+zuWZ10tjoEcsaSGOLtKRGFDfmu/dBxzl8yopUpa
+Tn79QKOieleRm5+uCcKCPTeKV0GbhDntCZJ+Yiw6ZPmrpcjDowAoMQ9kiMVa10+Q
+WwwoaRWuqhf+dL6Q2OLFOxlyCDKVSyW0YF4Vrf3fKGyxKJmszAL+NS1mVcdxuQIN
+BGCsMn0BEADLrIesbpfdAfWRvUFDN+PoRfa0ROwa/JOMhEgVsowQuk9No8yRva/X
+VyiA6oCq6na7IvZXMxT7di4FWDjDtw5xHjbtFg336IJTGBcnzm7WIsjvyyw8kKfB
+8cvG7D2OkzAUF8SVXLarJ1zdBP/Dr1Nz6F/gJsx5+BM8wGHEz4DsdMRV7ZMTVh6b
+PaGuPZysPjSEw62R8MFJ1fSyDGCKJYwMQ/sKFzseNaY/kZVR5lq0dmhiYjNVQeG9
+HJ6ZCGSGT5PKNOwx/UEkT6jhvzWgfr2eFVGJTcdwSLEgIrJIDzP7myHGxuOiuCmJ
+ENgL1f7mzGkJ/hYXq1RWqsn1Fh2I9KZMHggqu4a+s3RiscmNcbIlIhJLXoE1bxZ/
+TfYZ9Aod6Bd5TsSMTZNwV2am9zelhDiFF60FWww/5nEbhm/X4suC9W86qWBxs3Kh
+vk1dxhElRjtgwUEHA5OFOO48ERHfR7COH719D/YmqLU3EybBgJbGoC/yjlGJxv0R
+kOMAiG2FneNKEZZihReh8A5Jt6jYrSoHFRwL6oJIZfLezB7Rdajx1uH7uYcUyIaE
+SiDWlkDw/IFM315NYFA8c1TCSIfnabUYaAxSLNFRmXnt+GQpm44qAK1x8EGhY633
+e5B4FWorIXx0tTmsVM4rkQ6IgAodeywKG+c2Ikd+5dQLFmb7dW/6CwARAQABiQI2
+BBgBCgAgFiEEJwNOf9uFDgu8LGL/gGuyiu13mGkFAmCsMn0CGwwACgkQgGuyiu13
+mGkYWxAAkzF64SVpYvY9nY/QSYikL8UHlyyqirs6eFZ3Mj9lMRpHM2Spn9a3c701
+0Ge4wDbRP2oftCyPP+p9pdUA77ifMTlRcoMYX8oXAuyE5RT2emBDiWvSR6hQQ8bZ
+WFNXal+bUPpaRiruCCUPD2b8Od1ftzLqbYOosxr/m5Du0uahgOuGw6zlGBJCVOo7
+UB2Y++oZ8P7oDGF722opepWQ+bl2a6TRMLNWWlj4UANknyjlhyZZ7PKhWLjoC6MU
+dAKcwQUdp+XYLc/3b00bvgju0e99QgHZMX2fN3d3ktdN5Q2fqiAi5R6BmCCO4ISF
+o5j10gGU/sdqGHvNhv5C21ibun7HEzMtxBhnhGmytfBJzrsj7GOReePsfTLoCoUq
+dFMOAVUDciVfRtL2m8cv42ZJOXtPfDjsFOf8AKJk40/tc8mMMqZP7RVBr9RWOoq5
+y9D37NfI6UB8rPZ6qs0a1Vfm8lIh2/k1AFECduXgftMDTsmmXOgXXS37HukGW7AL
+QKWiWJQF/XopkXwkyAYpyuyRMZ77oF7nuqLFnl5VVEiRo0Fwu45erebc6ccSwYZU
+8pmeSx7s0aJtxCZPSZEKZ3mn0BXOR32Cgs48CjzFWf6PKucTwOy/YO0/4Gt/upNJ
+3DyeINcYcKyD08DEIF9f5tLyoiD4xz+N23ltTBoMPyv4f3X/wCQ=
+=ch7z
+-----END PGP PUBLIC KEY BLOCK-----
--- a/src/validate.ts
+++ b/src/validate.ts
@@ -0,0 +1,69 @@
+import * as crypto from 'crypto';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import * as core from '@actions/core';
+import * as openpgp from 'openpgp';
+import * as fetch from 'node-fetch';
+
+import {
+  BASEURL,
+  getUploaderName,
+  setFailure,
+} from './helpers';
+
+const verify = async (filename: string) => {
+  try {
+    const uploaderName = getUploaderName();
+
+    // Read in public key
+    const publicKeyArmored = await fs.readFileSync(
+        path.join(__dirname, 'pgp_keys.asc'),
+        'utf-8',
+    );
+
+    // Get SHASUM and SHASUM signature files
+    const shasumRes = await fetch( `${BASEURL}.SHA256SUM`);
+    const shasum = await shasumRes.text();
+
+    const shaSigRes = await fetch( `${BASEURL}.SHA256SUM.sig`);
+    const shaSig = await shaSigRes.text();
+
+    // Verify shasum
+    const verified = await openpgp.verify({
+      message: await openpgp.cleartext.fromText(shasum),
+      signature: await openpgp.signature.readArmored(shaSig),
+      publicKeys: (await openpgp.key.readArmored(publicKeyArmored)).keys,
+    });
+    const {valid} = verified.signatures[0];
+    if (valid) {
+      core.info('==> SHASUM file signed by key id ' +
+          verified.signatures[0].keyid.toHex(),
+      );
+    } else {
+      setFailure('Codecov: Error validating SHASUM signature', true);
+    }
+
+    // Verify uploader
+    const uploaderSha = crypto.createHash(`sha256`);
+    const stream = fs.createReadStream(filename);
+    await stream
+        .on('data', (data) => {
+          uploaderSha.update(data);
+        }).on('end', async () => {
+          const hash = `${uploaderSha.digest('hex')}  ${uploaderName}`;
+          if (hash !== shasum) {
+            setFailure(
+                'Codecov: Uploader shasum does not match ' +
+                  `uploader hash: ${hash}, public hash: ${shasum}`,
+                true,
+            );
+          } else {
+            core.info('==> Uploader SHASUM verified');
+          }
+        });
+  } catch (err) {
+    setFailure(`Codecov: Error validating uploader: ${err.message}`, true);
+  }
+};
+export default verify;