@toptal/davinci-monorepo 8.1.3 → 8.1.4-alpha-CRT-5891-create-coverage-command-2488e674.2

package/bin/davinci-monorepo.js

@@ -7,6 +7,7 @@ import { createGraphGenerateCommand } from '../src/commands/graph-generate.js'
 import metricsCommand from '../src/commands/metrics.js'
 // eslint-disable-next-line no-restricted-syntax
 import codeownersCommand from '../src/commands/codeowners/index.js'
+import { coverageCommand } from '../src/commands/coverage.js'
 
 cliEngine.loadCommands(
   [
@@ -14,6 +15,7 @@ cliEngine.loadCommands(
     createGraphGenerateCommand,
     metricsCommand,
     codeownersCommand,
+    coverageCommand,
   ],
   'davinci-monorepo'
 )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.1.3",
+  "version": "8.1.4-alpha-CRT-5891-create-coverage-command-2488e674.2+2488e674",
   "description": "Monorepo utility tools",
   "publishConfig": {
     "access": "public"
@@ -33,24 +33,25 @@
     "url": "https://github.com/toptal/davinci/issues"
   },
   "dependencies": {
+    "@nodelib/fs.walk": "^1.2.6",
     "@oclif/core": "^1.16.1",
-    "@toptal/davinci-cli-shared": "2.3.0",
+    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-2488e674.34+2488e674",
     "chalk": "^4.1.2",
+    "codeowners": "5.1.1",
     "dependency-cruiser": "^12.5.0",
-    "execa": "^5.1.1",
-    "glob": "^8.0.3",
-    "ramda": "^0.28.0",
-    "@nodelib/fs.walk": "^1.2.6",
     "ervy": "^1.0.7",
+    "execa": "^5.1.1",
     "find-up": "5.0.0",
+    "glob": "^8.0.3",
     "ignore": "^5.2.0",
     "is-directory": "^0.3.1",
     "lodash": "4.17.21",
     "ora": "^5.4.1",
-    "true-case-path": "^1.0.3",
-    "codeowners": "5.1.1"
+    "ramda": "^0.28.0",
+    "true-case-path": "^1.0.3"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.2"
-  }
+  },
+  "gitHead": "2488e6747994019dbeab8517629432f68e9af814"
 }

package/src/commands/__snapshots__/group-coverage-by-codeowners.test.js.snap

@@ -0,0 +1,61 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`groupCoverageByCodeownersCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 1,
+  "commands": [],
+  "options": [
+    {
+      "flags": "-r, --repository <repository_name>",
+      "description": "specify repository name",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": true,
+      "short": "-r",
+      "long": "--repository",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
+  ],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "group-coverage-by-codeowners",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "TODO: group-coverage-by-codeowners",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
+`;

package/src/commands/codeowners/core/codeowners/codeowners.js

@@ -1,17 +1,22 @@
-/* eslint-disable import/no-extraneous-dependencies */
 // @ts-check
-const fs = require('fs')
-const ignore = require('ignore')
+import fs from 'fs'
+import ignore from 'ignore'
 
-const getCodeownersFilePath = require('../utils/get-codeowners-file-path')
+import getCodeownersFilePath from '../utils/get-codeowners-file-path.js'
 
+/**
+ * @param {string} pathString
+ */
 const ownerMatcher = pathString => {
-  // @ts-ignore
   const matcher = ignore({ ignorecase: false }).add(pathString)
 
   return matcher.ignores.bind(matcher)
 }
 
+/**
+ * @param {string} currentPath
+ * @param {string} fileName
+ */
 // eslint-disable-next-line func-style
 function Codeowners(currentPath, fileName = 'CODEOWNERS') {
   const { codeownersDirectory, codeownersFilePath } = getCodeownersFilePath(
@@ -52,16 +57,21 @@ function Codeowners(currentPath, fileName = 'CODEOWNERS') {
   this.ignore = ignore
 }
 
-const EMPTY_ARRAY = []
+Codeowners.prototype.getOwner =
+  /**
+   * @param {string} filePath
+   */
+  function getOwner(filePath) {
+    console.log({ filePath })
+    console.log({ entries: this.ownerEntries })
 
-Codeowners.prototype.getOwner = function getOwner(filePath) {
-  for (const entry of this.ownerEntries) {
-    if (entry.match(filePath)) {
-      return entry.usernames
+    for (const entry of this.ownerEntries) {
+      if (entry.match(filePath)) {
+        return entry.usernames
+      }
     }
-  }
 
-  return EMPTY_ARRAY
-}
+    return []
+  }
 
-module.exports = Codeowners
+export default Codeowners

package/src/commands/coverage.js

@@ -0,0 +1,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 ..')
+
+  generateTeamCoverageCommand(coverageCommand)
+  groupCoverageByCodeownersCommand(coverageCommand)
+
+  return coverage
+}

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

@@ -0,0 +1,138 @@
+import path from 'path'
+import * as url from 'url'
+import execa from 'execa'
+import fs from 'fs'
+
+import Codeowners from './codeowners/core/codeowners/codeowners.js'
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+const rootProjectPath = path.join(__dirname, '../../')
+
+const sanitizeTeamName = team => team.replace('/', '-').replace('@', '')
+
+const sanitizeNycPercentage = percentage =>
+  percentage === 'Unknown' ? 0 : percentage
+
+// eslint-disable-next-line max-statements
+const generateTeamCoverage = async () => {
+  const codeowners = new Codeowners(rootProjectPath)
+
+  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)
+
+  // eslint-disable-next-line no-console
+  console.log('Teams:', uniqueTeams)
+
+  const teams = uniqueTeams
+
+  await execa.command(`rm -rf coverage/teams`)
+  await execa.command(`mkdir coverage/teams`)
+
+  for await (const team of teams) {
+    const sanitizedTeam = sanitizeTeamName(team)
+
+    await execa.command(`mkdir coverage/teams/${sanitizedTeam}`)
+    await execa.command(`mkdir coverage/teams/${sanitizedTeam}/jest`)
+    await execa.command(`mkdir coverage/teams/${sanitizedTeam}/cypress`)
+  }
+
+  for await (const team of teams) {
+    // eslint-disable-next-line no-console
+    console.log('Team coverage:', team)
+
+    const sanitizedTeam = sanitizeTeamName(team)
+
+    await execa.command(
+      `cp coverage/jest/coverage-final-${sanitizedTeam}.json coverage/teams/${sanitizedTeam}/jest/coverage-final.json`
+    )
+
+    // TODO add nyc as deps?
+    await execa.command(
+      `yarn nyc report --temp-dir coverage/teams/${sanitizedTeam}/jest --reporter json-summary --reporter html --report-dir coverage/teams/${sanitizedTeam}/jest`
+    )
+
+    await execa.command(
+      `cp coverage/cypress/coverage-final-${sanitizedTeam}.json coverage/teams/${sanitizedTeam}/cypress/coverage-final.json`
+    )
+
+    await execa.command(
+      `yarn nyc report --temp-dir coverage/teams/${sanitizedTeam}/cypress --reporter json-summary --reporter html --report-dir coverage/teams/${sanitizedTeam}/cypress`
+    )
+  }
+
+  const results = []
+  const created_at = new Date().toISOString()
+
+  // TODO pass it as param
+  const repo = 'client-portal'
+
+  for await (const team of teams) {
+    const sanitizedTeam = sanitizeTeamName(team)
+    const result = {
+      created_at,
+      team,
+      repo,
+    }
+
+    const jestCoverageSummary = JSON.parse(
+      fs.readFileSync(
+        `coverage/teams/${sanitizedTeam}/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(
+        `coverage/teams/${sanitizedTeam}/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)
+  }
+
+  fs.writeFileSync(
+    'team-tests-coverage-results.json',
+    JSON.stringify(results, null, 2)
+  )
+}
+
+export const generateTeamCoverageCommand = program => {
+  return program
+    .createCommand('generate-team-coverage')
+    .description('TODO: generate-team-coverage')
+    .requiredOption(
+      '-r, --repository <repository_name>',
+      'specify repository name'
+    )
+    .action((_, options) => generateTeamCoverage(options))
+}

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

@@ -0,0 +1,99 @@
+import path from 'path'
+import fs from 'fs'
+import * as url from 'url'
+
+import Codeowners from './codeowners/core/codeowners/codeowners.js'
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+const rootProjectPath = path.join(__dirname, '../../')
+
+const readJestCoverageReport = () => {
+  const jestCoverageReportPath = path.join(
+    rootProjectPath,
+    'coverage/jest/coverage-final-jest.json'
+  )
+
+  const data = fs.readFileSync(jestCoverageReportPath, 'utf8')
+
+  return JSON.parse(data)
+}
+
+const readCypressCoverageReport = () => {
+  const cypressCoverageReportPath = path.join(
+    rootProjectPath,
+    'coverage/cypress/coverage-final-cypress.json'
+  )
+
+  const data = fs.readFileSync(cypressCoverageReportPath, 'utf8')
+
+  return JSON.parse(data)
+}
+
+const sanitizeTeamName = team => team.replace('/', '-').replace('@', '')
+
+const splitReportIntoTeams = (reportObj, teams, codeowners, coveragePath) => {
+  const teamsReport = {}
+
+  Object.entries(reportObj).forEach(([reportPathKey, report]) => {
+    const file = report.path
+    const relativePath = path.relative(rootProjectPath, file)
+
+    const owners = codeowners.getOwner(relativePath)
+
+    owners.forEach(owner => {
+      teamsReport[owner] = {
+        ...teamsReport[owner],
+        [reportPathKey]: report,
+      }
+    })
+  })
+
+  teams.map(team => {
+    const teamReport = teamsReport[team] || {}
+    const sanitizedTeamPath = sanitizeTeamName(team)
+
+    const reportPath = path.join(
+      rootProjectPath,
+      `${coveragePath}/coverage-final-${sanitizedTeamPath}.json`
+    )
+
+    fs.writeFileSync(reportPath, JSON.stringify(teamReport, null, 2))
+  })
+}
+
+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)
+
+  // eslint-disable-next-line no-console
+  console.log('Teams:', uniqueTeams)
+
+  return uniqueTeams
+}
+
+const groupCoverageByCodeowners = async options => {
+  console.log(options)
+
+  const jestReport = readJestCoverageReport()
+  const cypressReport = readCypressCoverageReport()
+
+  const codeowners = new Codeowners(rootProjectPath)
+  const teams = getAllTeams(codeowners)
+
+  splitReportIntoTeams(jestReport, teams, codeowners, 'coverage/jest')
+  splitReportIntoTeams(cypressReport, teams, codeowners, 'coverage/cypress')
+}
+
+export const groupCoverageByCodeownersCommand = program => {
+  return program
+    .createCommand('group-coverage-by-codeowners')
+    .description('TODO: group-coverage-by-codeowners')
+    .requiredOption(
+      '-r, --repository <repository_name>',
+      'specify repository name'
+    )
+    .action((_, options) => groupCoverageByCodeowners(options))
+}

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

@@ -0,0 +1,23 @@
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+import { groupCoverageByCodeownersCommand } from './group-coverage-by-codeowners.js'
+
+describe('groupCoverageByCodeownersCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('has the correct command structure', () => {
+    const command = groupCoverageByCodeownersCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/index.js

@@ -2,6 +2,7 @@ import detectCircularityCommandCreator from './commands/detect-circularity.js'
 import metricsCommandCreator from './commands/metrics.js'
 import { createGraphGenerateCommand } from './commands/graph-generate.js'
 import codeownersCommand from './commands/codeowners/index.js'
+import { coverageCommand } from './commands/coverage.js'
 import checkIfMonorepo from './utils/check-if-monorepo.js'
 import getPackages from './utils/get-packages.js'
 
@@ -15,6 +16,7 @@ export const commands = [
   metricsCommandCreator,
   createGraphGenerateCommand,
   codeownersCommand,
+  coverageCommand,
 ]
 
 export default {