Merge pull request #256 from codecov/fix-codecov-token

fix: Token should be codecov.token and update symlinks
codecov · Jul 26, 2021 · a3fff6f · a3fff6f
2 parents 814b881 + 8a4330f
commit a3fff6f
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 11 deletions.
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/src/helpers/files.js b/src/helpers/files.js
@@ -237,7 +237,7 @@ function getAllFiles(projectRoot, dirPath, args, arrayOfFiles = []) {
     if (isBlacklisted(projectRoot, file, manualBlacklist())) {
       return
     }
-    if (fs.statSync(path.join(dirPath, file)).isDirectory()) {
+    if (fs.lstatSync(path.join(dirPath, file)).isDirectory()) {
       arrayOfFiles = getAllFiles(
         projectRoot,
         path.join(dirPath, file),

diff --git a/src/helpers/token.js b/src/helpers/token.js
@@ -50,10 +50,18 @@ function getTokenFromYaml(projectRoot, args) {
           })
           const yamlConfig = yaml.load(fileContents)
           if (
-            yamlConfig['codecov_token'] &&
-            validateHelpers.validateToken(yamlConfig['codecov_token'])
+            yamlConfig['codecov'] &&
+            yamlConfig['codecov']['token'] &&
+            validateHelpers.validateToken(yamlConfig['codecov']['token'])
           ) {
-            return yamlConfig['codecov_token']
+            return yamlConfig['codecov']['token']
+          }
+
+          if (yamlConfig['codecov_token']) {
+            error(
+              `'codecov_token' is a deprecated field. Please switch to 'codecov.token' ` +
+              '(https://docs.codecov.com/docs/codecovyml-reference#codecovtoken)'
+            )
           }
         }
       } catch (err) {

diff --git a/test/fixtures/invalid_yaml/codecov.yaml b/test/fixtures/invalid_yaml/codecov.yaml
@@ -0,0 +1 @@
+codecov_token: faketoken
diff --git a/test/fixtures/yaml/.codecov.yml b/test/fixtures/yaml/.codecov.yml
@@ -1 +1,2 @@
-codecov_token: invalid token
+codecov:
+  token: invalid token
diff --git a/test/fixtures/yaml/codecov.yaml b/test/fixtures/yaml/codecov.yaml
@@ -1 +1,2 @@
-codecov_token: faketoken
+codecov:
+  token: faketoken
diff --git a/test/fixtures/yaml/codecov.yml b/test/fixtures/yaml/codecov.yml
@@ -1 +1,2 @@
-codecov_token: anotherfaketoken
+codecov:
+  token: anotherfaketoken
diff --git a/test/helpers/token.test.js b/test/helpers/token.test.js
@@ -1,4 +1,5 @@
 const path = require('path')
+const { expect, it } = require('@jest/globals')
 
 const fileHelpers = require('../../src/helpers/files')
 const tokenHelpers = require('../../src/helpers/token')
@@ -8,7 +9,15 @@ describe('Get tokens', () => {
     fileHelpers.fetchGitRoot(),
     'test/fixtures/yaml',
   )
-  console.log(fixturesDir)
+  const invalidFixturesDir = path.join(
+    fileHelpers.fetchGitRoot(),
+    'test/fixtures/invalid_yaml',
+  )
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
   describe('From yaml', () => {
     it('Returns empty with no yaml file', () => {
       expect(tokenHelpers.getTokenFromYaml('.')).toBe('')
@@ -19,6 +28,19 @@ describe('Get tokens', () => {
         tokenHelpers.getTokenFromYaml(fixturesDir, { verbose: true }),
       ).toBe('faketoken')
     })
+
+    it('Returns deprecation error from codecov_token', () => {
+      jest.spyOn(console, 'error').mockImplementation(() => {
+        // Intentionally empty
+      })
+      expect(
+        tokenHelpers.getTokenFromYaml(invalidFixturesDir, { verbose: true }),
+      ).toBe('')
+
+      expect(console.error).toHaveBeenCalledWith(
+        expect.stringContaining("'codecov_token' is a deprecated field"),
+      )
+    })
   })
 
   describe('From right source', () => {