Merge pull request #114 from codecov/timeouts

Add more timeout tries and decrease timeout time

.github/workflows/main.yml

@@ -1,23 +1,19 @@
-name: Example workflow for Codecov
-on: [push]
+name: Workflow for Codecov Action
+on: [push, pull_request]
 jobs:
   run:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-   
-#     - name: Setup Python  
-#       uses: actions/setup-python@master
-
-#     - name: Generate coverage report
-#       run: |
-#         pip install pytest
-#         pip install pytest-cov
-#         pytest --cov=./ --cov-report=xml
-
-    - name: Upload coverage to Codecov  
-      uses: ./
-      with:
-        token: ${{secrets.CODECOV_TOKEN}}
-        flags: unittest
-        name: codecov-1
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests and collect coverage
+        run: yarn run test-all
+      - name: Upload coverage to Codecov
+        uses: ./
+        with:
+          files: ./coverage/calculator/coverage-final.json,./coverage/index/coverage-final.json
+          file: ./coverage/coverage-final.json
+          flags: unittest
+          name: codecov-1

.github/workflows/release.yml

@@ -1,19 +0,0 @@
-on: create
-
-name: Release 
-jobs:
-  release:
-    name: Release Codecov GitHub Action
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-        with:
-          fetch-depth: 3
-      - name: Release Action
-        uses: technote-space/release-github-actions@v1
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CREATE_MINOR_VERSION_TAG: false
-          COMMIT_NAME: Release GitHub Action
-          BRANCH_NAME: master 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Codecov
+Copyright (c) 2019-2020 Codecov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,15 @@
-# Codecov GitHub Action 
+# Codecov GitHub Action
 
-[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1.0.4-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
-### Easily upload coverage reports to Codecov from GitHub Actions 
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1-undefined.svg?logo=github&logoColor=white&style=flat)](https://github.com/marketplace/actions/codecov)
+### Easily upload coverage reports to Codecov from GitHub Actions
 
->The latest release of this Action adds support for macOS and Windows builds!
+>The latest release of this Action adds support for tokenless uploads from GitHub Actions!
 
 ## Usage
 
-To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number as a `step` within your `workflow.yml` file. This Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to five additional inputs to customize the upload context.
+To integrate Codecov with your Actions pipeline, specify the name of this repository with a tag number (`@v1` is recommended) as a `step` within your `workflow.yml` file.
+
+If you have a *private repository*, this Action also requires you to [provide an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) from [codecov.io](https://www.codecov.io) (tip: in order to avoid exposing your token, store it as a `secret`). Optionally, you can choose to include up to four additional inputs to customize the upload context. **For public repositories, no token is needed**
 
 Inside your `.github/workflows/workflow.yml` file:
 
@@ -16,27 +18,32 @@ steps:
 - uses: actions/checkout@master
 - uses: codecov/codecov-action@v1
   with:
-    token: ${{ secrets.CODECOV_TOKEN }} #required
-    file: ./coverage.xml #optional
-    flags: unittests #optional
-    name: codecov-umbrella #optional
-    yml: ./codecov.yml #optional
-    fail_ci_if_error: true #optional (default = false)
+    token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+    file: ./coverage.xml # optional
+    files: ./coverage1.xml,./coverage2.xml # optional
+    flags: unittests # optional
+    name: codecov-umbrella # optional
+    fail_ci_if_error: true # optional (default = false)
 ```
->**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can [get an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) for your specific repo on [codecov.io](https://www.codecov.io). 
+>**Note**: This assumes that you've set your Codecov token inside *Settings > Secrets* as `CODECOV_TOKEN`. If not, you can [get an upload token](https://docs.codecov.io/docs/frequently-asked-questions#section-where-is-the-repository-upload-token-found-) for your specific repo on [codecov.io](https://www.codecov.io). Keep in mind that secrets are *not* available to forks of repositories.
 
 ## Arguments
 
-Codecov's Action currently supports five inputs from the user: `token`, `file`, `flags`,`name`, `yml`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below: 
+Codecov's Action currently supports five inputs from the user: `token`, `file`, `flags`,`name`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below:
+
+>**Update**: We've removed the `yml` parameter with the latest release of this action. Please put your custom codecov yaml file at the root of the repo because other locations will no longer be supported in the future.
 
 | Input  | Description | Usage |
 | :---:     |     :---:   |    :---:   |
-| `token`  | Used to authorize coverage report uploads  | *Required* |
+| `token`  | Used to authorize coverage report uploads  | *Required for private repos* |
 | `file`  | Path to the coverage report(s) | Optional
-| `flags`  | Flag the upload to group coverage metrics (unittests, uitests, etc.) | Optional
+| `files`  | Comma-separated paths to the coverage report(s) | Optional
+| `directory` | Directory to search for coverage reports. | Optional
+| `flags`  | Flag the upload to group coverage metrics (unittests, uitests, etc.). Multiple flags are separated by a comma (ui,chrome) | Optional
+| `env_vars`  | Environment variables to tag the upload with. Multiple env variables can be separated with commas (e.g. `OS,PYTHON`) | Optional
 | `name`  | Custom defined name for the upload | Optional
-| `yml`  | Path to codecov.yml config file | Optional
-| `fail_ci_if_error`  | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false***. | Optional
+| `fail_ci_if_error`  | Specify if CI pipeline should fail when Codecov runs into errors during upload. *Defaults to **false*** | Optional
+| `path_to_write_report` | Write upload file to path before uploading | Optional
 
 ### Example `workflow.yml` with Codecov Action
 
@@ -47,11 +54,14 @@ jobs:
   run:
     runs-on: ${{ matrix.os }}
     strategy:
-      matrix: 
+      matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: '3.7'
     steps:
     - uses: actions/checkout@master
-    - name: Setup Python  
+    - name: Setup Python
       uses: actions/setup-python@master
       with:
         python-version: 3.7
@@ -60,20 +70,23 @@ jobs:
         pip install pytest
         pip install pytest-cov
         pytest --cov=./ --cov-report=xml
-    - name: Upload coverage to Codecov  
+    - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml
+        files: ./coverage1.xml,./coverage2.xml
+        directory: ./coverage/reports/
         flags: unittests
+        env_vars: OS,PYTHON
         name: codecov-umbrella
-        yml: ./codecov.yml 
         fail_ci_if_error: true
+        path_to_write_report: ./coverage/codecov_report.gz
 ```
 ## Contributing
 
 Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
 
-## License 
+## License
 
 The code in this project is released under the [MIT License](LICENSE).

action.yml

@@ -1,29 +1,37 @@
 name: 'Codecov'
 description: 'GitHub Action that uploads coverage reports for your repository to codecov.io'
-author: 'Ibrahim Ali <@ibrahim0814> | Codecov'
-inputs: 
+author: 'Ibrahim Ali <@ibrahim0814> & Thomas Hu <@thomasrockhu> | Codecov'
+inputs:
   name:
     description: 'User defined upload name. Visible in Codecov UI'
-    required: false 
+    required: false
   token:
-    description: 'Repository upload token - get it from codecov.io'
-    required: true 
+    description: 'Repository upload token - get it from codecov.io. Required only for private repositories'
+    required: false
   file:
     description: 'Path to coverage file to upload'
     required: false
+  files:
+    description: 'Comma-separated list of files to upload'
+    required: false
+  directory:
+    description: 'Directory to search for coverage reports.'
+    required: false
   flags:
     description: 'Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome)'
     required: false
-  yml:
-    description: 'Specify the location of the .codecov.yml config file'
+  path_to_write_report:
+    description: 'Write upload file to path before uploading'
+    required: false
+  env_vars:
+    description: 'Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON)'
     required: false
   fail_ci_if_error:
     description: 'Specify whether or not CI build should fail if Codecov runs into an error during upload'
     required: false
 branding:
-  color: 'red' 
+  color: 'red'
   icon: 'umbrella'
 runs:
   using: 'node12'
   main: 'dist/index.js'
-   

index.js

@@ -1,7 +1,7 @@
 const core = require("@actions/core");
 const exec = require("@actions/exec");
-const request = require("request");
 const fs = require("fs");
+const request = require('requestretry');
 
 let fail_ci;
 try {
@@ -9,7 +9,11 @@ try {
   const token = core.getInput("token");
   const flags = core.getInput("flags");
   const file = core.getInput("file");
-  const yml = core.getInput("yml");
+  const files = core.getInput("files");
+  const env_vars = core.getInput("env_vars");
+  const dir = core.getInput("directory");
+  const write_path = core.getInput("path_to_write_report");
+
   fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
 
   if (
@@ -24,142 +28,133 @@ try {
     fail_ci = false;
   }
 
-  request("https://codecov.io/bash", (error, response, body) => {
-    if (error && fail_ci) {
-      throw error;
-    } else if (error) {
-      core.warning(`Codecov warning: ${error.message}`);
-    }
-
-    fs.writeFile("codecov.sh", body, err => {
-      if (err && fail_ci) {
-        throw err;
-      } else if (err) {
-        core.warning(`Codecov warning: ${err.message}`);
+  request({
+    json: false,
+    maxAttempts: 10,
+    timeout: 3000,
+    url: "https://codecov.io/bash"
+  }, (error, response, body) => {
+    try {
+      if (error && fail_ci) {
+        throw error;
+      } else if (error) {
+        core.warning(`Codecov warning: ${error.message}`);
       }
 
-      let output = "";
-      let execError = "";
-      const options = {};
-      options.listeners = {
-        stdout: data => {
-          output += data.toString();
-        },
-        stderr: data => {
-          execError += data.toString();
+      fs.writeFile("codecov.sh", body, err => {
+        if (err && fail_ci) {
+          throw err;
+        } else if (err) {
+          core.warning(`Codecov warning: ${err.message}`);
         }
-      };
 
-      options.env = {
-        CODECOV_TOKEN: `${token}`,
-        GITHUB_ACTION: process.env.GITHUB_ACTION,
-        GITHUB_REF: process.env.GITHUB_REF,
-        GITHUB_REPOSITORY: process.env.GITHUB_REPOSITORY,
-        GITHUB_SHA: process.env.GITHUB_SHA
-      };
-
-      if (file) {
-        if (fail_ci) {
-          exec
-            .exec(
-              "bash",
-              [
-                "codecov.sh",
-                "-f",
-                `${file}`,
-                "-n",
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`,
-                "-Z"
-              ],
-              options
-            )
-            .catch(err => {
-              core.setFailed(
-                `Codecov failed with the following error: ${err.message}`
-              );
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        } else {
-          exec
-            .exec(
-              "bash",
-              [
-                "codecov.sh",
-                "-f",
-                `${file}`,
-                "-n",
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`
-              ],
-              options
-            )
-            .catch(err => {
-              core.warning(`Codecov warning: ${err.message}`);
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        }
-      } else {
-        if (fail_ci) {
-          exec
-            .exec(
-              "bash",
-              [
-                "codecov.sh",
-                "-n",
-                `${name}`,
-                "-F",
-                `${flags}`,
-                "-y",
-                `${yml}`,
-                "-Z"
-              ],
-              options
-            )
-            .catch(err => {
-              core.setFailed(
-                `Codecov failed with the following error: ${err.message}`
-              );
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        } else {
-          exec
-            .exec(
-              "bash",
-              ["codecov.sh", "-n", `${name}`, "-F", `${flags}`, "-y", `${yml}`],
-              options
-            )
-            .catch(err => {
-              core.warning(`Codecov warning: ${err.message}`);
-            })
-            .then(() => {
-              unlinkFile();
-            });
-        }
-      }
-
-      const unlinkFile = () => {
-        fs.unlink("codecov.sh", err => {
-          if (err && fail_ci) {
-            throw err;
-          } else if (err) {
-            core.warning(`Codecov warning: ${err.message}`);
+        let output = "";
+        let execError = "";
+        const options = {};
+        options.listeners = {
+          stdout: data => {
+            output += data.toString();
+          },
+          stderr: data => {
+            execError += data.toString();
           }
+        };
+
+        options.env = Object.assign(process.env, {
+          GITHUB_ACTION: process.env.GITHUB_ACTION,
+          GITHUB_RUN_ID: process.env.GITHUB_RUN_ID,
+          GITHUB_REF: process.env.GITHUB_REF,
+          GITHUB_REPOSITORY: process.env.GITHUB_REPOSITORY,
+          GITHUB_SHA: process.env.GITHUB_SHA,
+          GITHUB_HEAD_REF: process.env.GITHUB_HEAD_REF || ''
         });
-      };
-    });
+
+        if(token){
+          options.env.CODECOV_TOKEN = token
+        }
+
+        const env_vars_arg = []
+        for (let env_var of env_vars.split(",")) {
+          let env_var_clean = env_var.trim();
+          if (env_var_clean) {
+            options.env[env_var_clean] = process.env[env_var_clean];
+            env_vars_arg.push(env_var_clean)
+          }
+        }
+
+        const execArgs = ["codecov.sh"];
+        if (file) {
+          execArgs.push(
+            "-f", `${file}`
+          );
+        }
+
+        if (files) {
+          files.split(',').forEach(f => {
+            execArgs.push(
+              "-f", `${f}`
+            );
+          });
+        }
+
+        if (dir) {
+          execArgs.push(
+            "-s", `${dir}`
+          );
+        }
+
+        execArgs.push(
+          "-n", `${name}`,
+          "-F", `${flags}`
+        );
+
+        if (fail_ci) {
+          execArgs.push(
+            "-Z"
+          );
+        }
+
+        if (env_vars_arg.length) {
+          execArgs.push(
+            "-e", env_vars_arg.join(",")
+          );
+        }
+
+        if (write_path) {
+          execArgs.push(
+            "-q", `${write_path}`
+          );
+        }
+
+        exec.exec("bash", execArgs, options)
+          .catch(err => {
+            if (fail_ci) {
+              core.setFailed(
+                `Codecov failed with the following error: ${err.message}`
+              );
+            } else {
+              core.warning(`Codecov warning: ${err.message}`);
+            }
+          })
+          .then(() => {
+            unlinkFile();
+          });
+
+        const unlinkFile = () => {
+          fs.unlink("codecov.sh", err => {
+            if (err && fail_ci) {
+              throw err;
+            } else if (err) {
+              core.warning(`Codecov warning: ${err.message}`);
+            }
+          });
+        };
+      });
+    } catch (error) {
+      core.setFailed(
+        `Codecov failed with the following error: ${error.message}`
+      );
+    }
   });
 } catch (error) {
   if (fail_ci) {

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+}

package.json

@@ -1,10 +1,13 @@
 {
   "name": "codecov-action",
-  "version": "1.0.5",
+  "version": "1.0.13",
   "description": "Upload coverage reports to Codecov from GitHub Actions",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest --coverage",
+    "test-calculator": "jest --testPathPattern=src/calculator/ --coverage --coverageDirectory=coverage/calculator",
+    "test-index": "jest --testPathPattern=src/index --coverage --coverageDirectory=coverage/index",
+    "test-all": "yarn run test && yarn run test-calculator && yarn run test-index",
     "build": "ncc build index.js"
   },
   "repository": {
@@ -12,8 +15,8 @@
     "url": "git+https://github.com/codecov/codecov-action.git"
   },
   "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "author": "Ibrahim Ali",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/codecov/codecov-action/issues"
   },
@@ -21,8 +24,16 @@
   "dependencies": {
     "@actions/core": "^1.2.0",
     "@actions/exec": "^1.0.1",
-    "@zeit/ncc": "^0.20.5",
+    "@types/jest": "^26.0.4",
+    "@zeit/ncc": "^0.22.3",
     "fs": "0.0.1-security",
-    "request": "^2.88.0"
-  }
+    "jest": "^26.1.0",
+    "jest-junit": "^10.0.0",
+    "request": "^2.88.0",
+    "requestretry": "^4.1.1",
+    "ts-jest": "^26.1.1",
+    "typescript": "^3.9.6",
+    "yarn": "^1.22.4"
+  },
+  "devDependencies": {}
 }

src/calculator/calculator.test.ts

@@ -0,0 +1,11 @@
+import Calculator from './calculator'
+
+test('adds 2 + 3 to equal 5', () => {
+  const calc = new Calculator()
+  expect(calc.add(2, 3)).toBe(5);
+});
+
+test('subtracts 2 - 3 to equal -1', () => {
+  const calc = new Calculator()
+  expect(calc.subtract(2, 3)).toBe(-1);
+});

src/calculator/calculator.ts

@@ -0,0 +1,10 @@
+export default class Calculator {
+
+  add(x : number, y : number) : number {
+    return x + y;
+  }
+
+  subtract(x: number, y: number) : number {
+    return x - y;
+  }
+}

src/index/index.test.ts

@@ -0,0 +1,11 @@
+import Index from "./index";
+
+test('test uncovered if', () => {
+  const indexObj = new Index();
+  expect(indexObj.uncovered_if()).toEqual(false);
+});
+
+test('fully covered', () => {
+  const indexObj = new Index();
+  expect(indexObj.fully_covered()).toEqual(true);
+});

src/index/index.ts

@@ -0,0 +1,21 @@
+export default class Index {
+
+  //This function is tested and part of it is uncovered
+  uncovered_if = (a = true) => {
+    if (a == true) {
+      return false
+    } else {
+      return true
+    }
+  }
+
+  //This function will be fully covered
+  fully_covered = () => {
+    return true
+  }
+
+  //This function will not be tested by unit tests
+  uncovered = () => {
+    return true
+  }
+}