chore: simplify logger initialization

- Move from "log" level to "info" level
- Use "silent" level in testing environment

Author: UlisesGascon

src/cli/checks.js

@@ -9,10 +9,10 @@ async function listCheckCommand (knex, options = {}) {
   const checks = await getAllComplianceChecks(knex)
   const implementedChecks = checks.filter(check => check.implementation_status === 'completed')
   implementedChecks.forEach(check => {
-    logger.log(`- ${check.code_name}: ${check.title}`)
+    logger.info(`- ${check.code_name}: ${check.title}`)
   })
-  logger.log('------------------------------------')
-  logger.log(`Implemented checks: ${implementedChecks.length}/${checks.length}.`)
+  logger.info('------------------------------------')
+  logger.info(`Implemented checks: ${implementedChecks.length}/${checks.length}.`)
   return implementedChecks
 }
 

src/cli/workflows.js

@@ -24,8 +24,8 @@ const commandList = [{
 const validCommandNames = commandList.map(({ name }) => name)
 
 function listWorkflowCommand (options = {}) {
-  logger.log('Available workflows: \n')
-  commandList.forEach(({ name, description }) => logger.log(`- ${name}: ${description}`))
+  logger.info('Available workflows:')
+  commandList.forEach(({ name, description }) => logger.info(`- ${name}: ${description}`))
   return commandList
 }
 

src/providers/index.js

@@ -60,7 +60,7 @@ const fetchRepoByFullName = async (fullName) => {
 
 const performScorecardAnalysis = async (repo) => {
   ensureGithubToken()
-  logger.log(`Running OSSF Scorecard for repository (${repo.full_name})...`)
+  logger.info(`Running OSSF Scorecard for repository (${repo.full_name})...`)
 
   const start = new Date().getTime()
   const { stdout, stderr } = await exec(`docker run -e GITHUB_AUTH_TOKEN=${process.env.GITHUB_TOKEN} --rm ${ossfScorecardSettings.dockerImage} --repo=${repo.html_url} --show-details --format=json`)
@@ -70,7 +70,7 @@ const performScorecardAnalysis = async (repo) => {
   const data = JSON.parse(stdout)
   const end = new Date().getTime()
   data.analysis_execution_time = (end - start)
-  logger.log(`OSSF Scorecard finished successfully for repository (${repo.full_name}) in ${data.analysis_execution_time / 1000}s`)
+  logger.info(`OSSF Scorecard finished successfully for repository (${repo.full_name}) in ${data.analysis_execution_time / 1000}s`)
   return data
 }
 

src/utils/index.js

@@ -1,13 +1,14 @@
 const { add, parseISO, isBefore } = require('date-fns')
 const isURL = require('validator/lib/isURL.js')
-const pino = require('pino')({
+const pinoInit = require('pino')
+const logger = pinoInit({
   transport: {
     target: 'pino-pretty',
     options: {
       ignore: 'pid,hostname'
     }
   },
-  level: process.env.PINO_LOG_LEVEL || 'trace'
+  level: process.env.NODE_ENV === 'test' ? 'silent' : 'info'
 })
 
 const validateGithubUrl = (url) => isURL(url, { protocols: ['https'], require_protocol: true }) && url.includes('github.com')
@@ -18,21 +19,6 @@ const ensureGithubToken = () => {
   }
 }
 
-const defineLog = (type) => function () {
-  if (process.env.NODE_ENV === 'test') {
-    return () => {}
-  }
-
-  return pino[type](...arguments)
-}
-
-const logger = {
-  info: defineLog('info'),
-  error: defineLog('error'),
-  warn: defineLog('warn'),
-  log: defineLog('trace')
-}
-
 const getSeverityFromPriorityGroup = (priorityGroup) => {
   const priorityType = priorityGroup[0]
   const priorityValue = parseInt(priorityGroup.slice(1), 10)

src/workflows/index.js

@@ -25,7 +25,7 @@ const updateGithubOrgs = async (knex) => {
     debug('Updating organization in database')
     await updateGithubOrganization(mappedData)
   }))
-  logger.log('GitHub organizations updated successfully')
+  logger.info('GitHub organizations updated successfully')
 }
 
 const upsertGithubRepositories = async (knex) => {
@@ -65,12 +65,12 @@ const runAllTheComplianceChecks = async (knex) => {
   debug('Fetching all compliance checks')
   const complianceChecks = await getAllComplianceChecks()
   const implementedChecks = complianceChecks.filter(check => check.implementation_status === 'completed')
-  logger.log('Running all implemented checks sequentially')
+  logger.info('Running all implemented checks sequentially')
   for (const check of implementedChecks) {
-    logger.log(`Running check (${check.code_name})`)
+    logger.info(`Running check (${check.code_name})`)
     await checks[check.code_name](knex)
   }
-  logger.log('All checks ran successfully')
+  logger.info('All checks ran successfully')
 }
 
 const upsertOSSFScorecardAnalysis = async (knex) => {
@@ -80,12 +80,12 @@ const upsertOSSFScorecardAnalysis = async (knex) => {
   if (repositories.length === 0) {
     throw new Error('No repositories found. Please add repositories before running this workflow.')
   }
-  logger.log('Running OSSF Scorecard for all repositories')
-  logger.log('This may take a while...')
+  logger.info('Running OSSF Scorecard for all repositories')
+  logger.info('This may take a while...')
   const chunks = chunkArray(repositories, ossfScorecardSettings.parallelJobs)
   for (let i = 0; i < chunks.length; i++) {
     const chunk = chunks[i]
-    logger.log(`Processing chunk ${i + 1} of ${chunks.length} including ${chunk.length} repositories`)
+    logger.info(`Processing chunk ${i + 1} of ${chunks.length} including ${chunk.length} repositories`)
     await Promise.all(chunk.map(async (repo) => {
       debug(`Running OSSF Scorecard for repository (${repo.full_name})`)
       try {
@@ -102,7 +102,7 @@ const upsertOSSFScorecardAnalysis = async (knex) => {
     }))
   }
 
-  logger.log('The OSSF Scorecard ran successfully')
+  logger.info('The OSSF Scorecard ran successfully')
 }
 
 module.exports = {