@toptal/davinci-monorepo 8.1.4-alpha-CRT-5891-create-coverage-command-3ad3dcfd.4 → 8.1.4-alpha-CRT-5891-create-coverage-command-0a4adac5.7

package/README.md

@@ -12,3 +12,4 @@ Use it by installing `yarn add @toptal/davinci-monorepo` in your project.
 - [`metrics -m, --metric package-afferent-relations`](./docs/metrics.md): calculate package Afferent relations
 - [`graph generate`](./docs/graph-generate.md): generate dependency graph into `monorepo-graph.svg` file
 - [`codeowners`](./docs/codeowners.md): show list of tools available for code ownership analysis
+- [`coverage`](./docs/coverage.md): show list of code coverage commands

package/docs/coverage.md

@@ -0,0 +1,25 @@
+### Code coverage commands
+
+Streamline code coverage analysis and reporting by organizing coverage reports based on code owners and generating team-specific coverage reports, enabling teams to track and assess code quality and testing coverage more effectively.
+
+#### `group-coverage-by-codeowners`
+
+Reads code coverage reports for Jest and Cypress, groups the coverage data based on code owners, and writes separate coverage reports for each team
+
+The command utilizes the Codeowners class, which is responsible for identifying the code owners associated with each file.
+
+```sh
+codeowners group-coverage-by-codeowners
+```
+
+#### `generage-team-coverage`
+
+Generates team-specific coverage reports by copying and processing coverage data from Jest and Cypress reports. The resulting coverage reports provide insights into the code coverage metrics for each team.
+
+```sh
+coverage generage-team-coverage [options]
+
+Options:
+  -r, --repository <repository_name>         specify repository name
+  -o, --output-file-name <output_file_name>  specify output file name
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-3ad3dcfd.4+3ad3dcfd",
+  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-0a4adac5.7+0a4adac5",
   "description": "Monorepo utility tools",
   "publishConfig": {
     "access": "public"
@@ -35,7 +35,7 @@
   "dependencies": {
     "@nodelib/fs.walk": "^1.2.6",
     "@oclif/core": "^1.16.1",
-    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-3ad3dcfd.36+3ad3dcfd",
+    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-0a4adac5.39+0a4adac5",
     "chalk": "^4.1.2",
     "codeowners": "5.1.1",
     "commander": "^10.0.0",
@@ -55,5 +55,5 @@
   "devDependencies": {
     "@jest/globals": "^29.4.2"
   },
-  "gitHead": "3ad3dcfdfe83b96377701fd4b2534f7c209ca320"
+  "gitHead": "0a4adac5650c666f07b97522a76b2f30dd604738"
 }

package/src/commands/codeowners/core/owners-info/get-owners-summary.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-param-reassign, id-length*/
 import { NO_OWNER } from '../../config.js'
 import formatOwnerName from '../utils/format-owner-name.js'
-import getPercentage from '../utils/get-persentage.js'
+import { getPercentage } from '../utils/get-percentage.js'
 import totalFilesComparator from '../utils/total-files-comparator.js'
 
 export const getSingleOwnerSummary = (

package/src/commands/codeowners/core/utils/get-percentage.js

@@ -0,0 +1,2 @@
+export const getPercentage = (fraction, total) =>
+  `${((fraction / total) * 100).toFixed(2)}%`

package/src/commands/codeowners/index.js

@@ -5,7 +5,7 @@ import listCommand from './commands/list.js'
 import ownersInformationCommand from './commands/owners-information.js'
 import packagesInformationCommand from './commands/packages-information.js'
 
-const codeowners = program => {
+const codeownersCommand = program => {
   const codeowners = program
     .createCommand('codeowners')
     .description(
@@ -22,4 +22,4 @@ const codeowners = program => {
   return codeowners
 }
 
-export default codeowners
+export default codeownersCommand

package/src/commands/coverage-command/generate-team-coverage.js

@@ -12,45 +12,55 @@ import {
   JEST_COVERAGE_PATH,
   TEAMS_COVERAGE_PATH,
 } from './config.js'
+import { getUniqueTeams } from './services/get-unique-teams/get-unique-teams.js'
 
 const workspaceRoot = getWorkspaceRoot()
 
 const sanitizeNycPercentage = percentage =>
   percentage === 'Unknown' ? 0 : percentage
 
+const getCoverageSummary = (type, teamPath) => {
+  const result = {}
+
+  const coverageSummary = JSON.parse(
+    fs.readFileSync(`${teamPath}/${type}/coverage-summary.json`, 'utf8')
+  )
+
+  result[`${type}_lines_coverage`] = sanitizeNycPercentage(
+    coverageSummary.total.lines.pct
+  )
+  result[`${type}_statements_coverage`] = sanitizeNycPercentage(
+    coverageSummary.total.statements.pct
+  )
+  result[`${type}_functions_coverage`] = sanitizeNycPercentage(
+    coverageSummary.total.functions.pct
+  )
+  result[`${type}_branches_coverage`] = sanitizeNycPercentage(
+    coverageSummary.total.branches.pct
+  )
+
+  return result
+}
+
 // eslint-disable-next-line max-statements
 const generateTeamCoverage = async options => {
   print.header('Generating team coverage')
 
   const codeowners = new Codeowners(workspaceRoot)
-
-  const ownerEntries = codeowners.ownerEntries
-  const uniqueTeams = ownerEntries
-    .flatMap(entry => entry.usernames)
-    // eslint-disable-next-line id-length
-    .filter((v, i, a) => a.indexOf(v) === i)
-
-  print.grey('Teams: ', uniqueTeams)
-
-  const teams = uniqueTeams
+  const teams = getUniqueTeams(codeowners.ownerEntries)
 
   await execa.command(`rm -rf ${TEAMS_COVERAGE_PATH}`)
   await execa.command(`mkdir ${TEAMS_COVERAGE_PATH}`)
 
   for await (const team of teams) {
+    print.grey('Team coverage: ', team)
+
     const sanitizedTeam = sanitizeTeamName(team)
     const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
 
     await execa.command(`mkdir ${sanitizedTeamPath}`)
     await execa.command(`mkdir ${sanitizedTeamPath}/jest`)
     await execa.command(`mkdir ${sanitizedTeamPath}/cypress`)
-  }
-
-  for await (const team of teams) {
-    print.grey('Team coverage: ', team)
-
-    const sanitizedTeam = sanitizeTeamName(team)
-    const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
 
     await execa.command(
       `cp ${JEST_COVERAGE_PATH}/coverage-final-${sanitizedTeam}.json ${sanitizedTeamPath}/jest/coverage-final.json`
@@ -74,49 +84,20 @@ const generateTeamCoverage = async options => {
     const sanitizedTeam = sanitizeTeamName(team)
     const sanitizedTeamPath = path.join(TEAMS_COVERAGE_PATH, sanitizedTeam)
 
+    const jestCoverageSummary = getCoverageSummary('jest', sanitizedTeamPath)
+    const cypressCoverageSummary = getCoverageSummary(
+      'cypress',
+      sanitizedTeamPath
+    )
+
     const result = {
       created_at,
       team,
       repo: options.repository,
+      ...jestCoverageSummary,
+      ...cypressCoverageSummary,
     }
 
-    const jestCoverageSummary = JSON.parse(
-      fs.readFileSync(`${sanitizedTeamPath}/jest/coverage-summary.json`, 'utf8')
-    )
-
-    result.jest_lines_coverage = sanitizeNycPercentage(
-      jestCoverageSummary.total.lines.pct
-    )
-    result.jest_statements_coverage = sanitizeNycPercentage(
-      jestCoverageSummary.total.statements.pct
-    )
-    result.jest_functions_coverage = sanitizeNycPercentage(
-      jestCoverageSummary.total.functions.pct
-    )
-    result.jest_branches_coverage = sanitizeNycPercentage(
-      jestCoverageSummary.total.branches.pct
-    )
-
-    const cypressCoverageSummary = JSON.parse(
-      fs.readFileSync(
-        `${sanitizedTeamPath}/cypress/coverage-summary.json`,
-        'utf8'
-      )
-    )
-
-    result.cypress_lines_coverage = sanitizeNycPercentage(
-      cypressCoverageSummary.total.lines.pct
-    )
-    result.cypress_statements_coverage = sanitizeNycPercentage(
-      cypressCoverageSummary.total.statements.pct
-    )
-    result.cypress_functions_coverage = sanitizeNycPercentage(
-      cypressCoverageSummary.total.functions.pct
-    )
-    result.cypress_branches_coverage = sanitizeNycPercentage(
-      cypressCoverageSummary.total.branches.pct
-    )
-
     results.push(result)
   }
 
@@ -126,7 +107,7 @@ const generateTeamCoverage = async options => {
 export const generateTeamCoverageCommand = program =>
   program
     .command('generate-team-coverage')
-    .description('TODO: generate-team-coverage')
+    .description('Generate team-specific coverage reports')
     .requiredOption(
       '-r, --repository <repository_name>',
       'specify repository name'

package/src/commands/coverage-command/group-coverage-by-codeowners.js

@@ -7,51 +7,29 @@ import getWorkspaceRoot from 'find-yarn-workspace-root'
 import Codeowners from '../codeowners/core/codeowners/codeowners.js'
 import { CYPRESS_COVERAGE_PATH, JEST_COVERAGE_PATH } from './config.js'
 import { sanitizeTeamName } from './services/sanitize-team-name/sanitize-team-name.js'
+import { getUniqueTeams } from './services/get-unique-teams/get-unique-teams.js'
 
 const workspaceRoot = getWorkspaceRoot()
 
-const readJestCoverageReport = () => {
-  const jestCoverageReportPath = path.join(
-    workspaceRoot,
-    JEST_COVERAGE_PATH,
-    'coverage-final-jest.json'
-  )
-
+const readCoverageReport = reportPathName => {
+  const jestCoverageReportPath = path.join(workspaceRoot, reportPathName)
   const data = fs.readFileSync(jestCoverageReportPath, 'utf8')
 
   return JSON.parse(data)
 }
 
-const readCypressCoverageReport = () => {
-  const cypressCoverageReportPath = path.join(
-    workspaceRoot,
-    CYPRESS_COVERAGE_PATH,
-    'coverage-final-cypress.json'
-  )
-
-  const data = fs.readFileSync(cypressCoverageReportPath, 'utf8')
-
-  return JSON.parse(data)
-}
-
-const splitReportIntoTeams = ({
-  reportObj,
-  teams,
-  codeowners,
-  coveragePath,
-}) => {
+const splitReportIntoTeams = ({ report, teams, codeowners, coveragePath }) => {
   const teamsReport = {}
 
-  Object.entries(reportObj).forEach(([reportPathKey, report]) => {
-    const file = report.path
-    const relativeWorkspacePath = path.relative(workspaceRoot, file)
-
+  Object.entries(report).forEach(([reportPathKey, reportValue]) => {
+    const filePath = reportValue.path
+    const relativeWorkspacePath = path.relative(workspaceRoot, filePath)
     const owners = codeowners.getOwner(relativeWorkspacePath)
 
     owners.forEach(owner => {
       teamsReport[owner] = {
         ...teamsReport[owner],
-        [reportPathKey]: report,
+        [reportPathKey]: reportValue,
       }
     })
   })
@@ -70,26 +48,18 @@ const splitReportIntoTeams = ({
   })
 }
 
-const getAllTeams = codeowners => {
-  const ownerEntries = codeowners.ownerEntries
-  const uniqueTeams = ownerEntries
-    .flatMap(entry => entry.usernames)
-    // eslint-disable-next-line id-length
-    .filter((v, i, a) => a.indexOf(v) === i)
-
-  print.grey('Teams: ', uniqueTeams)
-
-  return uniqueTeams
-}
-
 const groupCoverageByCodeowners = async () => {
   print.header('Grouping coverage by codeowners')
 
-  const jestReport = readJestCoverageReport()
-  const cypressReport = readCypressCoverageReport()
+  const jestReport = readCoverageReport(
+    path.join(JEST_COVERAGE_PATH, 'coverage-final-jest.json')
+  )
+  const cypressReport = readCoverageReport(
+    path.join(CYPRESS_COVERAGE_PATH, 'coverage-final-cypress.json')
+  )
 
   const codeowners = new Codeowners(workspaceRoot)
-  const teams = getAllTeams(codeowners)
+  const teams = getUniqueTeams(codeowners.ownerEntries)
 
   splitReportIntoTeams({
     report: jestReport,
@@ -108,5 +78,5 @@ const groupCoverageByCodeowners = async () => {
 export const groupCoverageByCodeownersCommand = program =>
   program
     .command('group-coverage-by-codeowners')
-    .description('TODO: group-coverage-by-codeowners')
+    .description('Group the coverage data based on code owners')
     .action(groupCoverageByCodeowners)

package/src/commands/coverage-command/index.js

@@ -2,7 +2,11 @@ import { generateTeamCoverageCommand } from './generate-team-coverage.js'
 import { groupCoverageByCodeownersCommand } from './group-coverage-by-codeowners.js'
 
 export const coverageCommand = program => {
-  const coverage = program.createCommand('coverage').description('TODO ..')
+  const coverage = program
+    .createCommand('coverage')
+    .description(
+      'Provides code coverage analysis, including organizing coverage reports by code owners and generating team-specific reports'
+    )
 
   groupCoverageByCodeownersCommand(coverage)
   generateTeamCoverageCommand(coverage)

package/src/commands/coverage-command/services/get-unique-teams/get-unique-teams.js

@@ -0,0 +1,11 @@
+import { print } from '@toptal/davinci-cli-shared'
+
+export const getUniqueTeams = teams => {
+  const uniqueTeams = teams
+    .flatMap(entry => entry.usernames)
+    .filter((teamName, index, allTeams) => allTeams.indexOf(teamName) === index)
+
+  print.grey('Teams: ', uniqueTeams)
+
+  return uniqueTeams
+}

package/src/commands/coverage-command/services/get-unique-teams/get-unique-teams.test.js

@@ -0,0 +1,40 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { jest } from '@jest/globals'
+
+import { getUniqueTeams } from './get-unique-teams'
+
+jest.unstable_mockModule('@toptal/davinci-cli-shared', () => ({
+  print: {
+    grey: jest.fn(),
+  },
+}))
+
+const { print } = await import('@toptal/davinci-cli-shared')
+
+describe('getUniqueTeams', () => {
+  beforeEach(() => {
+    print.grey.mockImplementation(jest.fn())
+  })
+
+  it.each([
+    [
+      [
+        { usernames: ['team1', 'team2'] },
+        { usernames: ['team3', 'team4'] },
+        { usernames: ['team1', 'team5'] },
+      ],
+      ['team1', 'team2', 'team3', 'team4', 'team5'],
+    ],
+    [
+      [
+        { usernames: ['team1', 'team2', 'team2', 'team3'] },
+        { usernames: ['team4', 'team1', 'team4', 'team5'] },
+      ],
+      ['team1', 'team2', 'team3', 'team4', 'team5'],
+    ],
+  ])('returns the unique teams for the given input', (teams, expected) => {
+    const result = getUniqueTeams(teams)
+
+    expect(result).toEqual(expected)
+  })
+})

package/src/commands/coverage-command/services/sanitize-team-name/sanitize-team-name.test.js

@@ -0,0 +1,13 @@
+import { sanitizeTeamName } from './sanitize-team-name'
+
+describe('sanitizeTeamName', () => {
+  it.each([
+    ['@package/frontend-experience-eng', 'package-frontend-experience-eng'],
+    ['@package/screening-ops-eng', 'package-screening-ops-eng'],
+    ['@package/client-retention-eng', 'package-client-retention-eng'],
+  ])('sanitizes the team name correctly', (input, expected) => {
+    const result = sanitizeTeamName(input)
+
+    expect(result).toBe(expected)
+  })
+})

package/src/commands/codeowners/core/utils/get-persentage.js

@@ -1,5 +0,0 @@
-const getPercentage = (fraction, total) => {
-  return `${((fraction / total) * 100).toFixed(2)}%`
-}
-
-export default getPercentage