Merge pull request #602 from codecov/feat/gcov

michael-codecov · web-flow · commit 134b0d98c26a · 2022-02-03T15:55:17.000-07:00
Add gcov support
diff --git a/HELPFILE b/HELPFILE
@@ -1,40 +1,44 @@
 Options:
-  -b, --build    Specify the build number manually
-  -B, --branch   Specify the branch manually
-  -e, --env      Specify environment variables to be included with this build.
-                 Also accepting environment variables: CODECOV_ENV=VAR,VAR2
-  -C, --sha      Specify the commit SHA mannually
-  -f, --file     Target file(s) to upload
-  -F, --flags    Flag the upload to group coverage metrics         [default: ""]
-  -n, --name     Custom defined name of the upload. Visible in Codecov UI
-                                                                   [default: ""]
-  -N, --parent   The commit SHA of the parent for which you are uploading
-                 coverage. If not present, 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 to the commit.
-  -P, --pr       Specify the pull request number mannually
-  -s, --dir      Directory to search for coverage reports.
-                 Already searches project root and current working directory
-  -t, --token    Codecov upload token                              [default: ""]
-  -T, --tag      Specify the git tag                               [default: ""]
-  -v, --verbose  Run with verbose logging                              [boolean]
-  -R, --rootDir  Specify the project root directory when not in a git repo
-  -Z, --nonZero  Should errors exit with a non-zero (default: false)
-                                                      [boolean] [default: false]
-  -d, --dryRun   Don't upload files to Codecov                         [boolean]
-  -r, --slug     Specify the slug manually
-  -u, --url      Change the upload host (Enterprise use)
-                                        [string] [default: "https://codecov.io"]
-  -c, --clean    Move discovered coverage reports to the trash
-                                                      [boolean] [default: false]
-  -X, --feature  Toggle functionalities.
-                 Separate multiple ones by comma: -X network,search
-                 -X network       Disable uploading the file network
-                 -X search        Disable searching for coverage files
-                                                                        [string]
-  -Q, --source   Used internally by Codecov, this argument helps track wrappers
-                 of the uploader (e.g. GitHub Action, CircleCI Orb)
-                                                          [string] [default: ""]
-      --version  Show version number                                   [boolean]
-  -h, --help     Show help                                             [boolean]
+  -b, --build       Specify the build number manually
+  -B, --branch      Specify the branch manually
+  -e, --env         Specify environment variables to be included with this build.
+                    Also accepting environment variables: CODECOV_ENV=VAR,VAR2
+  -C, --sha         Specify the commit SHA mannually
+  -f, --file        Target file(s) to upload
+  -F, --flags       Flag the upload to group coverage metrics         [default: ""]
+  -n, --name        Custom defined name of the upload. Visible in Codecov UI
+                                                                      [default: ""]
+  -N, --parent      The commit SHA of the parent for which you are uploading
+                    coverage. If not present, 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 to the commit.
+  -P, --pr          Specify the pull request number mannually
+  -s, --dir         Directory to search for coverage reports.
+                    Already searches project root and current working directory
+  -t, --token       Codecov upload token                              [default: ""]
+  -T, --tag         Specify the git tag                               [default: ""]
+  -v, --verbose     Run with verbose logging                              [boolean]
+  -R, --rootDir     Specify the project root directory when not in a git repo
+  -Z, --nonZero     Should errors exit with a non-zero (default: false)
+                                                         [boolean] [default: false]
+  -d, --dryRun      Don't upload files to Codecov                         [boolean]
+  -r, --slug        Specify the slug manually
+  -u, --url         Change the upload host (Enterprise use)
+                                           [string] [default: "https://codecov.io"]
+  -c, --clean       Move discovered coverage reports to the trash
+                                                         [boolean] [default: false]
+  -X, --feature     Toggle functionalities.
+                     Separate multiple ones by comma: -X network,search
+                     -X network       Disable uploading the file network
+                     -X search        Disable searching for coverage files
+                                                                          [string]
+  -Q, --source      Used internally by Codecov, this argument helps track wrappers
+                    of the uploader (e.g. GitHub Action, CircleCI Orb)
+                                                             [string] [default: ""]
+      --gcov        Run with gcov support                [boolean] [default: false]
+      --gcovIgnore  Paths to ignore during gcov gathering                  [string]
+      --gcovInclude Paths to include during gcov gathering                 [string]
+      --gcovArgs    Extra arguments to pass to gcov                        [string]
+  --version         Show version number                                   [boolean]
+  -h, --help        Show help                                             [boolean]
diff --git a/src/helpers/cli.ts b/src/helpers/cli.ts
@@ -160,6 +160,31 @@ const args: ICLIArgument[] = [
     description: `Used internally by Codecov, this argument helps track wrappers
       of the uploader (e.g. GitHub Action, CircleCI Orb)`,
   },
+  {
+    alias: 'g',
+    name: 'gcov',
+    type: 'boolean',
+    default: false,
+    description: 'Run with gcov support',
+  },
+  {
+    alias: 'gi',
+    name: 'gcovIgnore',
+    type: 'string',
+    description: 'Paths to ignore during gcov gathering',
+  },
+  {
+    alias: 'gI',
+    name: 'gcovInclude',
+    type: 'string',
+    description: 'Paths to include during gcov gathering',
+  },
+  {
+    alias: 'ga',
+    name: 'gcovArgs',
+    type: 'string',
+    description: 'Extra arguments to pass to gcov',
+  },
 ]
 
 export interface IYargsObject {
diff --git a/src/helpers/files.ts b/src/helpers/files.ts
@@ -27,7 +27,7 @@ export async function getFileListing(
   return getAllFiles(projectRoot, projectRoot, args).join('\n')
 }
 
-function manualBlocklist(): string[] {
+export function manualBlocklist(): string[] {
   // TODO: honor the .gitignore file instead of a hard-coded list
   return [
     '.DS_Store',
diff --git a/src/helpers/gcov.ts b/src/helpers/gcov.ts
@@ -0,0 +1,19 @@
+import glob from 'fast-glob'
+
+import { manualBlocklist } from '../../src/helpers/files'
+import { isProgramInstalled, runExternalProgram } from "./util"
+
+export async function generateGcovCoverageFiles(projectRoot: string, include: string[] = [], ignore: string[] = [], gcovArgs = '',): Promise<string> {
+    if (!isProgramInstalled('gcov')) {
+        throw new Error('gcov is not installed, cannot process files')
+    }
+
+    const globstar = (pattern: string) => `**/${pattern}`
+    const gcovInclude = ['*.gcno', ...include].map(globstar)
+    const gcovIgnore = [...manualBlocklist(), ...ignore].map(globstar)
+    const files = await glob(gcovInclude, {cwd: projectRoot, ignore: gcovIgnore, onlyFiles: true})
+    if (!files.length) {
+        throw new Error('No gcov files found')
+    }
+    return runExternalProgram('gcov', ['-pb', gcovArgs, ...files]);
+}
diff --git a/src/index.ts b/src/index.ts
@@ -22,6 +22,7 @@ import {
   readCoverageFile,
   removeFile,
 } from './helpers/files'
+import { generateGcovCoverageFiles } from './helpers/gcov'
 
 /**
  *
@@ -91,11 +92,12 @@ export async function main(
   /*
   Step 1: validate and sanitize inputs
   Step 2: detect if we are in a git repo
-  Step 3: get network (file listing)
-  Step 4: select coverage files (search or specify)
-  Step 5: generate upload file
-  Step 6: determine CI provider
-  Step 7: either upload or dry-run
+  Step 3: sanitize and set token
+  Step 4: get network (file listing)
+  Step 5: select coverage files (search or specify)
+  Step 6: generate upload file
+  Step 7: determine CI provider
+  Step 8: either upload or dry-run
   */
 
   // #region == Step 1: validate and sanitize inputs
@@ -153,6 +155,13 @@ export async function main(
   let requestedPaths: string[] = []
   
   // Look for files
+
+  if (args.gcov) {
+    UploadLogger.verbose('Running gcov...')
+    const gcovLogs = await generateGcovCoverageFiles(projectRoot)
+    UploadLogger.verbose(`${gcovLogs}`)
+  }
+  
   let coverageFilePaths: string[] = []
   if (args.file) {
     if (typeof args.file === 'string') {
diff --git a/src/types.ts b/src/types.ts
@@ -26,6 +26,10 @@ export interface UploaderArgs {
   upstream: string // Upstream proxy to connect to
   source?: string // Track wrappers of the uploader
   changelog?: string // Displays the changelog and exits
+  gcov?: string // Run with gcov support
+  gcovIgnore?: string // Paths to ignore during gcov gathering
+  gcovInclude?: string // Paths to include during gcov gathering
+  gcovArgs?: string // Extra arguments to pass to gcov
 }
 
 export type UploaderEnvs = NodeJS.Dict<string>
diff --git a/test/fixtures/gcov/main.c b/test/fixtures/gcov/main.c
@@ -0,0 +1,20 @@
+#include <stdio.h>
+
+void numbers(int num)
+{
+    if (num == 1) {
+        printf("Number is 1\n");
+    } else if (num == 2){
+        printf("Number is 2\n");
+    } else {
+        printf("Number is %d\n", num);
+    }
+}
+
+
+int main(void)
+{
+    numbers(1);
+    numbers(2);
+    return 0;
+}
diff --git a/test/fixtures/gcov/main.gcno b/test/fixtures/gcov/main.gcno
diff --git a/test/fixtures/gcov/makefile b/test/fixtures/gcov/makefile
@@ -0,0 +1,12 @@
+CC	= gcc
+CFLAG = -fPIC -fprofile-arcs -ftest-coverage
+RM	= rm -rf
+
+main : main.o
+	$(CC) $(CFLAG) -o main main.o
+
+main.o : main.c
+	$(CC) $(CFLAG) -c -Wall -Werror main.c
+
+clean:
+	$(RM) main *.o *.so *.gcno *.gcda *.gcov
diff --git a/test/helpers/gcov.test.ts b/test/helpers/gcov.test.ts
@@ -0,0 +1,62 @@
+
+import td from 'testdouble'
+import childProcess from 'child_process'
+import { generateGcovCoverageFiles } from '../../src/helpers/gcov'
+
+describe('generateGcovCoverageFiles()', () => {
+    afterEach(() => {
+        td.reset()
+    })
+
+    it('should find and run on test/fixtures/gcov/main.gcno', async () => {
+        const output = `File 'main.c'\nLines executed:0.00% of 11\nBranches executed:0.00% of 4\nTaken at least once:0.00% of 4\nCalls executed:0.00% of 5\nCreating 'main.c.gcov'\n\nLines executed:0.00% of 11`
+        const spawnSync = td.replace(childProcess, 'spawnSync')
+        td.when(spawnSync('gcov')).thenReturn({
+            stdout: 'gcov installed',
+            error: null
+        })
+        td.when(spawnSync('gcov', td.matchers.contains('test/fixtures/gcov/main.gcno'))).thenReturn({
+            stdout: output,
+            error: null
+        })
+        const projectRoot = process.cwd()
+        expect(await generateGcovCoverageFiles(projectRoot)).toBe(output)
+    })
+
+    it('should pass gcov arguments directly through', async () => {
+        const spawnSync = td.replace(childProcess, 'spawnSync')
+        td.when(spawnSync('gcov')).thenReturn({
+            stdout: 'gcov installed',
+            error: null
+        })
+        td.when(spawnSync('gcov', td.matchers.contains('NEWGCOVARG'))).thenReturn({
+            stdout: 'Matched',
+        })
+
+        const projectRoot = process.cwd()
+        expect(await generateGcovCoverageFiles(projectRoot, [], [], 'NEWGCOVARG')).toEqual("Matched")
+    })
+
+    it('should return an error when no gcno files found', async () => {
+        const spawnSync = td.replace(childProcess, 'spawnSync')
+        td.when(spawnSync('gcov')).thenReturn({
+            stdout: 'gcov installed',
+            error: null
+        })
+        td.when(spawnSync('gcov', td.matchers.contains('test'))).thenReturn({
+            stdout: 'No executable lines'
+        })
+        const projectRoot = process.cwd()
+        await expect(generateGcovCoverageFiles(projectRoot, [], ['test'])).rejects.toThrowError(/No gcov files found/)
+
+
+    })
+
+    it('should return an error when gcov is not installed', async () => {
+        const spawnSync = td.replace(childProcess, 'spawnSync')
+        td.when(spawnSync('gcov')).thenReturn({ error: "Command 'gcov' not found" })
+
+        const projectRoot = process.cwd()
+        await expect(generateGcovCoverageFiles(projectRoot, [], [], 'NEWGCOVARG')).rejects.toThrowError(/gcov is not installed/)
+    })
+})

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export async function getFileListing(`
`27`	`27`	`return getAllFiles(projectRoot, projectRoot, args).join('\n')`
`28`	`28`	`}`
`29`	`29`
`30`		`-function manualBlocklist(): string[] {`
	`30`	`+export function manualBlocklist(): string[] {`
`31`	`31`	`// TODO: honor the .gitignore file instead of a hard-coded list`
`32`	`32`	`return [`
`33`	`33`	`'.DS_Store',`