Skip to content

Commit c6722c3

Browse files
drazisil-codecovdrazisil-codecov
committed
refactor: change to use not log methods
in places where needed rename symbols or pass args
1 parent 344bd82 commit c6722c3

File tree

8 files changed

+74
-62
lines changed

8 files changed

+74
-62
lines changed

‎src/ci_providers/provider_azurepipelines.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const childProcess = require('child_process')
2-
const { log } = require('../helpers/logger')
2+
const { error, info, verbose } = require('../helpers/logger')
33

44
function detect(envs) {
55
return !!envs.SYSTEM_TEAMFOUNDATIONSERVERURI
@@ -63,7 +63,7 @@ function _getSHA(inputs) {
6363
.trimRight()
6464
if (mergeCommitRegex.exec(mergeCommitMessage)) {
6565
const mergeCommit = mergeCommitMessage.split(' ')[1]
66-
log(` Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
66+
info(` Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
6767
commit = mergeCommit
6868
}
6969
}

‎src/ci_providers/provider_githubactions.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const childProcess = require('child_process')
2-
const { log } = require('../helpers/logger')
2+
const { error, info, verbose } = require('../helpers/logger')
33

44
function detect(envs) {
55
return envs.GITHUB_ACTIONS
@@ -70,10 +70,10 @@ function _getSHA(inputs) {
7070
.trimRight()
7171
if (mergeCommitRegex.exec(mergeCommitMessage)) {
7272
const mergeCommit = mergeCommitMessage.split(' ')[1]
73-
log(` Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
73+
info(` Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
7474
commit = mergeCommit
7575
} else if (mergeCommitMessage === '') {
76-
log(
76+
info(
7777
'-> Issue detecting commit SHA. Please run actions/checkout with fetch-depth > 1 or set to 0',
7878
)
7979
}

‎src/helpers/files.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const fs = require('fs')
44
const glob = require('glob')
55
const path = require('path').posix
66

7-
const { log } = require('./logger')
7+
const { error, info, verbose } = require('./logger')
88

99
/**
1010
*
@@ -230,7 +230,7 @@ function parseGitIgnore(projectRoot) {
230230
* @returns {string[]}
231231
*/
232232
function getAllFiles(projectRoot, dirPath, args, arrayOfFiles = []) {
233-
log(`Searching for files in ${dirPath}`, { level: 'debug', args })
233+
verbose(`Searching for files in ${dirPath}`, args.verbose)
234234
const files = fs.readdirSync(dirPath)
235235

236236
files.forEach(function (file) {
@@ -250,7 +250,7 @@ function getAllFiles(projectRoot, dirPath, args, arrayOfFiles = []) {
250250
)
251251
}
252252
})
253-
log(`Search complete for files in ${dirPath}`, { level: 'debug', args })
253+
verbose(`Search complete for files in ${dirPath}`, args.verbose)
254254
return arrayOfFiles
255255
}
256256

@@ -332,7 +332,7 @@ function getFilePath(projectRoot, filePath) {
332332
function removeFile(projectRoot, filePath) {
333333
fs.unlink(getFilePath(projectRoot, filePath), err => {
334334
if (err) {
335-
log(`Error removing ${filePath} coverage file`)
335+
error(`Error removing ${filePath} coverage file`)
336336
}
337337
})
338338
}

‎src/helpers/token.js

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,29 @@ const fs = require('fs')
22
const path = require('path')
33
const yaml = require('js-yaml')
44

5-
const { log } = require('./logger')
5+
const { error, info, verbose } = require('./logger')
66
const validateHelpers = require('./validate')
77

88
function getToken(inputs, projectRoot) {
99
const { args, envs } = inputs
1010
const options = [
1111
[args.token, 'arguments'],
1212
[envs.CODECOV_TOKEN, 'environment variables'],
13-
[getTokenFromYaml(projectRoot), 'Codecov yaml config'],
13+
[getTokenFromYaml(projectRoot, args), 'Codecov yaml config'],
1414
]
1515

1616
for (const option of options) {
1717
if (option[0] && validateHelpers.validateToken(option[0])) {
18-
log(`-> Token set by ${option[1]}`)
18+
info(`-> Token set by ${option[1]}`)
1919
return option[0]
2020
}
2121
}
2222

2323
return ''
2424
}
2525

26-
function getTokenFromYaml(projectRoot) {
27-
const dirNames = [
28-
'',
29-
'.github',
30-
'dev',
31-
]
26+
function getTokenFromYaml(projectRoot, args) {
27+
const dirNames = ['', '.github', 'dev']
3228

3329
const yamlNames = [
3430
'.codecov.yaml',
@@ -39,30 +35,32 @@ function getTokenFromYaml(projectRoot) {
3935

4036
for (const dir of dirNames) {
4137
for (const name of yamlNames) {
42-
const filePath = path.join(projectRoot, dir, name);
38+
const filePath = path.join(projectRoot, dir, name)
4339

4440
try {
4541
if (fs.existsSync(filePath)) {
4642
const fileContents = fs.readFileSync(filePath, {
47-
encoding: 'utf-8',
48-
});
49-
const yamlConfig = yaml.load(fileContents);
43+
encoding: 'utf-8',
44+
})
45+
const yamlConfig = yaml.load(fileContents)
5046
if (
51-
yamlConfig['codecov_token'] &&
52-
validateHelpers.validateToken(yamlConfig['codecov_token'])
47+
yamlConfig['codecov_token'] &&
48+
validateHelpers.validateToken(yamlConfig['codecov_token'])
5349
) {
5450
return yamlConfig['codecov_token']
5551
}
5652
}
57-
} catch(err) {
58-
log(`Error searching for upload token in ${filePath}: ${err}`, { level: 'debug' })
53+
} catch (err) {
54+
verbose(
55+
`Error searching for upload token in ${filePath}: ${err}`,
56+
args.verbose,
57+
)
5958
}
6059
}
6160
}
6261
return ''
6362
}
6463

65-
6664
module.exports = {
6765
getToken,
6866
getTokenFromYaml,

‎src/helpers/web.js

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const superagent = require('superagent')
22
const { version } = require('../../package.json')
33
const validateHelpers = require('./validate')
4-
const { log } = require('./logger')
4+
const { error, info, verbose } = require('./logger')
55

66
/**
77
*
@@ -15,12 +15,14 @@ function populateBuildParams(inputs, serviceParams) {
1515
serviceParams.name = args.name || envs.CODECOV_NAME || ''
1616
serviceParams.tag = args.tag || ''
1717
let flags
18-
if (typeof(args.flags) === 'object') {
18+
if (typeof args.flags === 'object') {
1919
flags = [...args.flags]
2020
} else {
2121
flags = [args.flags]
2222
}
23-
serviceParams.flags = flags.filter((flag) => validateHelpers.validateFlags(flag)).join(',')
23+
serviceParams.flags = flags
24+
.filter(flag => validateHelpers.validateFlags(flag))
25+
.join(',')
2426
serviceParams.parent = args.parent || ''
2527
return serviceParams
2628
}
@@ -40,7 +42,7 @@ function getPackage(source) {
4042
* @returns {Promise<{ status: string, resultURL: string }>}
4143
*/
4244
async function uploadToCodecovPUT(uploadURL, uploadFile) {
43-
log('Uploading...')
45+
info('Uploading...')
4446

4547
const parts = uploadURL.split('\n')
4648
const putURL = parts[1]
@@ -75,7 +77,11 @@ async function uploadToCodecovPUT(uploadURL, uploadFile) {
7577
async function uploadToCodecov(uploadURL, token, query, uploadFile, source) {
7678
try {
7779
const result = await superagent
78-
.post(`${uploadURL}/upload/v4?package=${getPackage(source)}&token=${token}&${query}`)
80+
.post(
81+
`${uploadURL}/upload/v4?package=${getPackage(
82+
source,
83+
)}&token=${token}&${query}`,
84+
)
7985
.retry()
8086
.send(uploadFile)
8187
.set('Content-Type', 'text/plain')

‎src/index.js

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const fileHelpers = require('./helpers/files')
55
const validateHelpers = require('./helpers/validate')
66
const tokenHelpers = require('./helpers/token')
77
const webHelpers = require('./helpers/web')
8-
const { log } = require('./helpers/logger')
8+
const { error, info, verbose } = require('./helpers/logger')
99
const providers = require('./ci_providers')
1010

1111
/**
@@ -17,13 +17,13 @@ const providers = require('./ci_providers')
1717
* @param {string} source
1818
*/
1919
function dryRun(uploadHost, token, query, uploadFile, source) {
20-
log('==> Dumping upload file (no upload)')
21-
log(
20+
info('==> Dumping upload file (no upload)')
21+
info(
2222
`${uploadHost}/upload/v4?package=${webHelpers.getPackage(
2323
source,
2424
)}&token=${token}&${query}`,
2525
)
26-
log(uploadFile)
26+
info(uploadFile)
2727
}
2828

2929
/**
@@ -72,17 +72,17 @@ async function main(args) {
7272
? args.url
7373
: 'https://codecov.io'
7474

75-
log(generateHeader(getVersion()))
75+
info(generateHeader(getVersion()))
7676

7777
// == Step 2: detect if we are in a git repo
7878
const projectRoot = args.rootDir || fileHelpers.fetchGitRoot()
7979
if (projectRoot === '') {
80-
log(
80+
info(
8181
'=> No git repo detected. Please use the -R flag if the below detected directory is not correct.',
8282
)
8383
}
8484

85-
log(`=> Project root located at: ${projectRoot}`)
85+
info(`=> Project root located at: ${projectRoot}`)
8686

8787
// == Step 3: sanitize and set token
8888
const token = await tokenHelpers.getToken(inputs, projectRoot)
@@ -91,7 +91,7 @@ async function main(args) {
9191
let uploadFile = ''
9292

9393
if (!args.feature || args.feature.split(',').includes('network') === false) {
94-
log('Start of network processing...', { level: 'debug', args })
94+
verbose('Start of network processing...', args.verbose)
9595
let fileListing
9696
try {
9797
fileListing = await fileHelpers.getFileListing(projectRoot, args)
@@ -109,15 +109,15 @@ async function main(args) {
109109
// Look for files
110110
let coverageFilePaths = []
111111
if (!args.file) {
112-
log('Searching for coverage files...')
112+
info('Searching for coverage files...')
113113
coverageFilePaths = fileHelpers.getCoverageFiles(
114114
args.dir || projectRoot,
115115
// TODO: Determine why this is so slow (I suspect it's walking paths it should not)
116116
fileHelpers.coverageFilePatterns(),
117117
)
118118
if (coverageFilePaths.length > 0) {
119-
log(`=> Found ${coverageFilePaths.length} possible coverage files:`)
120-
log(coverageFilePaths.join('\n'))
119+
info(`=> Found ${coverageFilePaths.length} possible coverage files:`)
120+
info(coverageFilePaths.join('\n'))
121121
} else {
122122
throw new Error(
123123
'No coverage files located, please try use `-f`, or change the project root with `-R`',
@@ -137,7 +137,7 @@ async function main(args) {
137137
throw new Error('No coverage files found, exiting.')
138138
}
139139
}
140-
log('End of network processing', { level: 'debug', args })
140+
verbose('End of network processing', args.verbose)
141141

142142
// == Step 6: generate upload file
143143
// TODO: capture envs
@@ -146,13 +146,13 @@ async function main(args) {
146146
for (const coverageFile of coverageFilePaths) {
147147
let fileContents
148148
try {
149-
log(`Processing ${coverageFile}...`),
149+
info(`Processing ${coverageFile}...`),
150150
(fileContents = await fileHelpers.readCoverageFile(
151151
args.dir || projectRoot,
152152
coverageFile,
153153
))
154-
} catch (error) {
155-
log(`Could not read coverage file (${coverageFile}): ${error}`)
154+
} catch (err) {
155+
info(`Could not read coverage file (${coverageFile}): ${err}`)
156156
continue
157157
}
158158

@@ -190,7 +190,7 @@ async function main(args) {
190190
let serviceParams
191191
for (const provider of providers) {
192192
if (provider.detect(envs)) {
193-
log(`Detected ${provider.getServiceName()} as the CI provider.`)
193+
info(`Detected ${provider.getServiceName()} as the CI provider.`)
194194
serviceParams = provider.getServiceParams(inputs)
195195
break
196196
}
@@ -210,13 +210,14 @@ async function main(args) {
210210
return dryRun(uploadHost, token, query, uploadFile, args.source)
211211
}
212212

213-
log(
213+
info(
214214
`Pinging Codecov: ${uploadHost}/upload/v4?package=${webHelpers.getPackage(
215215
args.source,
216216
)}&token=*******&${query}`,
217217
)
218+
verbose(`Passed token was ${token.length} characters long`, args.verbose)
218219
try {
219-
log(
220+
info(
220221
`${uploadHost}/upload/v4?package=${webHelpers.getPackage(
221222
args.source,
222223
)}&${query}
@@ -225,6 +226,7 @@ async function main(args) {
225226
X-Reduced-Redundancy: 'false'`,
226227
{ level: 'debug', args },
227228
)
229+
228230
const uploadURL = await webHelpers.uploadToCodecov(
229231
uploadHost,
230232
token,
@@ -233,16 +235,16 @@ async function main(args) {
233235
args.source,
234236
)
235237

236-
log(uploadURL, { level: 'debug', args })
238+
verbose(uploadURL, args.verbose)
237239

238-
log(
240+
verbose(
239241
`${uploadURL.split('\n')[1]}
240242
Content-Type: 'text/plain'
241243
Content-Encoding: 'gzip'`,
242-
{ level: 'debug', args },
244+
args.verbose,
243245
)
244246
const result = await webHelpers.uploadToCodecovPUT(uploadURL, gzippedFile)
245-
log(JSON.stringify(result))
247+
info(JSON.stringify(result))
246248
return result
247249
} catch (error) {
248250
throw new Error(`Error uploading to ${uploadHost}: ${error}`)
@@ -271,7 +273,6 @@ function getVersion() {
271273
}
272274

273275
module.exports = {
274-
log,
275276
main,
276277
getVersion,
277278
generateHeader,

‎test/helpers/files.test.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ describe('File Helpers', () => {
3939
})
4040

4141
it('can get a file listing', async () => {
42-
expect(await fileHelpers.getFileListing('.')).toMatch('npm-shrinkwrap.json')
42+
expect(await fileHelpers.getFileListing('.', { verbose: true })).toMatch(
43+
'npm-shrinkwrap.json',
44+
)
4345
})
4446

4547
it('can parse the .gitignore file', () => {

0 commit comments

Comments
 (0)