Merge pull request #180 from codecov/1.1.0

Bump to 1.1.0

.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Workflow for Codecov Action
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - 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
+      - name: Upload coverage to Codecov (verbose)
+        uses: ./
+        with:
+          files: ./coverage/calculator/coverage-final.json,./coverage/index/coverage-final.json
+          file: ./coverage/coverage-final.json
+          flags: unittest
+          name: codecov-1
+          verbose: true

.gitignore

@@ -0,0 +1,95 @@
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# react / gatsby
+public/
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# macOS Finder metadata
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,13 @@
+### 1.1.0
+
+#### Features
+- #110 Add "working-directory:" input
+- #174 Support Xcode specificed parameters
+
+#### Fixes
+- #172 File is saved as text
+
+#### Dependencies and Misc
+- #166 Bump requestretry from 4.1.1 to 4.1.2
+- #169 Bump typescript from 4.0.5 to 4.1.2
+- #178 Bump @types/jest from 26.0.15 to 26.0.19

CONTRIBUTING.md

@@ -6,8 +6,8 @@ The following is a set of guidelines for contributing to this repository, which
 
 ## What does this repo do?
 
-This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. What's essentially happening in the background is that Actions is spinning up a Linux Docker container with the contents of this repository. Inside that container, we then call a shell scipt that runs Codecov's Bash uploader. 
+This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. Our Node action uses the Actions toolkit to make system calls that allow us to run Codecov's bash uploader inside of Node. Essentially what we're doing in this action is downloading Codecov's bash uploader script from codecov.io/bash, saving it as a file in the current directory, executing the file via `exec` calls, then removing the script from the current directory. 
 
-## PRs and Support
+## PRs, Issues, and Support
 
-Feel free to clone, modify code and request a PR to this repository. All PRs will be reviewed by the Codecov team. If your PR has been sitting for a while or if you have any questions, ping us at support@codecov.io 
+Feel free to clone, modify code and request a PR to this repository. All PRs and issues will be reviewed by the Codecov team. If your PR/issue has been sitting for a while or if you have any questions, ping us at support@codecov.io 

Dockerfile

@@ -1,10 +0,0 @@
-FROM alpine:3.10
-
-WORKDIR /app
-COPY . /app
-
-RUN apk add --no-cache curl bash git
-
-RUN chmod +x /app/entrypoint.sh
-
-ENTRYPOINT [ "/app/entrypoint.sh" ]

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,21 +1,53 @@
-<!-- <p align="center"><img  src="./codecov-logo.png"  /></p> -->
-
 # Codecov GitHub Action
-### 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)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action?ref=badge_shield)
+### Easily upload coverage reports to Codecov from GitHub Actions
+
+>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 (`@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:
 
 ```yaml
 steps:
 - uses: actions/checkout@master
-- uses: actions/codecov-action@v0.3
+- uses: codecov/codecov-action@v1
   with:
-    token: ${{secrets.CODECOV_TOKEN}} #for private repos
+    token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-    file: ./coverage.xml #optional
+    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)
+    verbose: 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 for your specific repo on codecov.io. A token is *not* required for public repositories. 
+>**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`, and `fail_ci_if_error`. These inputs, along with their descriptions and usage contexts, are listed in the table below:
+
+| Input  | Description | Usage |
+| :---:     |     :---:   |    :---:   |
+| `token`  | Used to authorize coverage report uploads  | *Required for private repos* |
+| `file`  | Path to the coverage report(s) | 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
+| `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
+| `verbose` | Specify whether the Codecov output should be verbose | Optional
+| `working-directory` | Directory in which to execute `codecov.sh` | Optional
+| `xcode_derived_data` | Custom Derived Data Path for Coverage.profdata and gcov processing | Optional
+| `xcode_package` | Specify packages to build coverage. Uploader will only build these packages. This can significantly reduces time to build coverage reports. -J 'MyAppName' Will match "MyAppName" and "MyAppNameTests" -J '^ExampleApp$' Will match only "ExampleApp" not "ExampleAppTests" | Optional
 
 ### Example `workflow.yml` with Codecov Action
 
@@ -24,36 +56,45 @@ name: Example workflow for Codecov
 on: [push]
 jobs:
   run:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      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:
-        version: 3.7
+        python-version: 3.7
-
     - name: Generate coverage report
       run: |
         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
-      uses: codecov/codecov-action@v0.2
       with:
-        token: ${{secrets.CODECOV_TOKEN}}
+        token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml
+        files: ./coverage1.xml,./coverage2.xml
+        directory: ./coverage/reports/
+        flags: unittests
+        env_vars: OS,PYTHON
+        name: codecov-umbrella
+        fail_ci_if_error: true
+        path_to_write_report: ./coverage/codecov_report.txt
+        verbose: true
 ```
+## Contributing
 
-## Arguments
+Contributions are welcome! Check out the [Contribution Guide](CONTRIBUTING.md).
 
-| Argument  | Description |
+## License
-| :---:     |     :---:   | 
+
-| `token`  | Used to authorize coverage report uploads  |
+The code in this project is released under the [MIT License](LICENSE).
-| `file`  | Location of the coverage report |
 
 
-## License 
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-action?ref=badge_large)
-
-The code in this project is released under the [MIT License](LICENSE)

action.yml

@@ -1,19 +1,43 @@
 name: 'Codecov'
-description: 'GitHub action that uploads coverage reports for your repository to codecov.io'
+description: 'GitHub Action that uploads coverage reports for your repository to codecov.io'
-author: 'Ibrahim Ali @ Codecov'
+author: 'Ibrahim Ali <@ibrahim0814> & Thomas Hu <@thomasrockhu> | Codecov'
-inputs: 
+inputs:
+  name:
+    description: 'User defined upload name. Visible in Codecov UI'
+    required: false
   token:
-    description: 'Set the repository token'
+    description: 'Repository upload token - get it from codecov.io. Required only for private repositories'
-    required: false 
+    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
+  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
+  verbose:
+    description: 'Specify whether the Codecov output should be verbose'
+    required: false
+  working-directory:
+    description: 'Directory in which to execute codecov.sh'
+    required: false
 branding:
-  color: 'red' 
+  color: 'red'
   icon: 'umbrella'
 runs:
-  using: 'docker'
+  using: 'node12'
-  image: 'Dockerfile'
+  main: 'dist/index.js'
-  args:
-    - ${{ inputs.token }}
-    - ${{ inputs.file }}

entrypoint.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -eu
-
-if [ $# -eq 0 ]
-then
-  bash <(curl -s https://codecov.io/bash)
-elif [ "x$INPUT_TOKEN" != "x" ] && [ "x$INPUT_FILE" != "x" ]
-then
-  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN -f $INPUT_FILE
-elif [ "x$INPUT_TOKEN" != "x" ]
-then
-  bash <(curl -s https://codecov.io/bash) -t $INPUT_TOKEN
-elif [ "x$INPUT_FILE" != "x" ]
-then
-  bash <(curl -s https://codecov.io/bash) -f $INPUT_FILE
-fi
-

index.js

@@ -0,0 +1,193 @@
+const core = require("@actions/core");
+const exec = require("@actions/exec");
+const fs = require("fs");
+const request = require('requestretry');
+
+let fail_ci;
+try {
+  const name = core.getInput("name");
+  const token = core.getInput("token");
+  const flags = core.getInput("flags");
+  const file = core.getInput("file");
+  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");
+  const verbose = core.getInput("verbose");
+  const working_dir = core.getInput("working-directory");
+  const xcode_derived_data = core.getInput("xcode_derived_data");
+  const xcode_package = core.getInput("xcode_package");
+
+  fail_ci = core.getInput("fail_ci_if_error").toLowerCase();
+
+  if (
+    fail_ci === "yes" ||
+    fail_ci === "y" ||
+    fail_ci === "true" ||
+    fail_ci === "t" ||
+    fail_ci === "1"
+  ) {
+    fail_ci = true;
+  } else {
+    fail_ci = false;
+  }
+
+  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}`);
+      }
+
+      fs.writeFile("codecov.sh", body, 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"];
+        execArgs.push("-Q", "github-action");
+
+        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}`
+          );
+        }
+
+        if (verbose) {
+          execArgs.push(
+            "-v"
+          );
+        }
+
+        if (working_dir) {
+          options.cwd = working_dir;
+        }
+
+        if (xcode_derived_data) {
+          execArgs.push(
+            "-D", `${xcode_derived_data}`
+          );
+        }
+
+        if (xcode_package) {
+          execArgs.push(
+            "-J", `${xcode_package}`
+          );
+        }
+
+        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) {
+    core.setFailed(`Codecov failed with the following error: ${error.message}`);
+  } else {
+    core.warning(`Codecov warning: ${error.message}`);
+  }
+}

jest.config.js

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

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "codecov-action",
+  "version": "1.0.16",
+  "description": "Upload coverage reports to Codecov from GitHub Actions",
+  "main": "index.js",
+  "scripts": {
+    "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": {
+    "type": "git",
+    "url": "git+https://github.com/codecov/codecov-action.git"
+  },
+  "keywords": [],
+  "author": "Ibrahim Ali",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/codecov/codecov-action/issues"
+  },
+  "homepage": "https://github.com/codecov/codecov-action#readme",
+  "dependencies": {
+    "@actions/core": "^1.2.6",
+    "@actions/exec": "^1.0.4",
+    "@types/jest": "^26.0.19",
+    "@zeit/ncc": "^0.22.3",
+    "fs": "0.0.1-security",
+    "jest": "^26.6.3",
+    "jest-junit": "^12.0.0",
+    "request": "^2.88.2",
+    "requestretry": "^4.1.2",
+    "ts-jest": "^26.4.4",
+    "typescript": "^4.1.2",
+    "yarn": "^1.22.10"
+  },
+  "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
+  }
+}