feat: add sha option for testing and update schema to include branch

bjohansebas · ljharb · commit cf02bbcda197 · 2025-02-16T19:50:20.000-05:00
diff --git a/USAGE.md b/USAGE.md
@@ -74,6 +74,7 @@ against the patch branch wiby had created.
 Options:
 
   --dependent  URL of a dependent                                       [string]
+  --sha        Commit or branch that was chosen for testing             [string]
   --config     Path to the configuration file. By default it will try to load
                the configuration from the first file it finds in the current
                working directory: `.wiby.json`, `.wiby.js`              [string]
@@ -95,6 +96,7 @@ Options:
   --dependent           URL of a dependent                              [string]
   --pull-request, --pr  Raise a draft PR in addition to creating a branch
                                                                        [boolean]
+  --sha                 Test against a specific commit or branch        [string]
   --config              Path to the configuration file. By default it will try
                         to load the configuration from the first file it finds
                         in the current working directory: `.wiby.json`,
diff --git a/bin/commands/result.js b/bin/commands/result.js
@@ -10,6 +10,10 @@ exports.builder = (yargs) => yargs
     type: 'string',
     conflicts: 'config'
   })
+  .option('sha', {
+    desc: 'Commit or branch that was chosen for testing',
+    type: 'string'
+  })
   .option('config', {
     desc: 'Path to the configuration file. By default it will try to load the configuration from the first file it finds in the current working directory: `.wiby.json`, `.wiby.js`',
     type: 'string'
@@ -18,7 +22,7 @@ exports.builder = (yargs) => yargs
 exports.handler = async (params) => {
   const config = params.dependent
     ? {
-        dependents: [{ repository: params.dependent }]
+        dependents: [{ repository: params.dependent, sha: params.sha || 'HEAD' }]
       }
     : wiby.validate({ config: params.config })
 
diff --git a/bin/commands/test.js b/bin/commands/test.js
@@ -16,6 +16,10 @@ exports.builder = (yargs) => yargs
     type: 'boolean',
     conflicts: 'config'
   })
+  .option('sha', {
+    desc: 'Test against a specific commit or branch',
+    type: 'string'
+  })
   .option('config', {
     desc: 'Path to the configuration file. By default it will try to load the configuration from the first file it finds in the current working directory: `.wiby.json`, `.wiby.js`',
     type: 'string'
@@ -24,7 +28,7 @@ exports.builder = (yargs) => yargs
 exports.handler = (params) => {
   const config = params.dependent
     ? {
-        dependents: [{ repository: params.dependent, pullRequest: !!params['pull-request'] }]
+        dependents: [{ repository: params.dependent, pullRequest: !!params['pull-request'], sha: params.sha || 'HEAD' }]
       }
     : wiby.validate({ config: params.config })
 
diff --git a/docs/DRAFT-FLOW.md b/docs/DRAFT-FLOW.md
@@ -8,7 +8,7 @@
    - `wiby` would also be able to run on a specific commit.
    - [ ] Missing branch commit handling: [issue #46](https://github.com/pkgjs/wiby/issues/46)
 1. Indicate that you want to start your dependent tests by running `wiby test` while on the commit/branch/tag you wish to test.
-   - [ ] It's also possible to specify this using `--commit=sha`: [issue #49](https://github.com/pkgjs/wiby/issues/49)
+   - [x] It's also possible to specify this using `--sha=hash`: [issue #49](https://github.com/pkgjs/wiby/issues/49)
    - [ ] `wiby` will look for an existing log file for this HEAD, and error if it finds one. This will stop `wiby test` being run multiple times. You can override this check with `wiby test --overwrite`: [issue #50](https://github.com/pkgjs/wiby/issues/50)
    - [x] You can also run `--dependent` to specify a single dependent to test
 1. By default, `wiby` will look for your defined list of dependents to test against in `wiby.json`.
diff --git a/lib/config.js b/lib/config.js
@@ -14,7 +14,8 @@ const dependentSchema = joi.object({
       'git+https'
     ]
   }),
-  pullRequest: joi.boolean().optional()
+  pullRequest: joi.boolean().optional(),
+  sha: joi.string().optional().default('HEAD')
 }).unknown(false)
 
 exports.schema = joi.object({
diff --git a/lib/github.js b/lib/github.js
@@ -15,17 +15,27 @@ const graphqlWithAuth = graphql.defaults({
   }
 })
 
-module.exports.getPackageJson = async function getPackageJson (owner, repo) {
+module.exports.getPackageJson = async function getPackageJson (owner, repo, sha) {
   try {
     const resp = await graphqlWithAuth({
-      query: queries.getPackageJson,
-      owner: owner,
-      repo: repo
+      query: queries.getFiles,
+      owner,
+      repo,
+      sha
     })
-    return (JSON.parse(resp.repository.object.text))
+
+    const files = resp.repository.object.tree.entries
+
+    const packageJson = files != null ? files.find(file => file.name === 'package.json') : undefined
+
+    if (packageJson == null) {
+      throw new Error('Could not find the package.json in the repository')
+    }
+
+    return (JSON.parse(packageJson.object.text))
   } catch (err) {
     if (err.status === 404) {
-      throw Error(`Could not find GitHub repository at https://www.github.com/${owner}/${repo}`)
+      throw new Error(`Could not find GitHub repository at https://www.github.com/${owner}/${repo}`)
     } else {
       throw err
     }
@@ -51,10 +61,11 @@ module.exports.getDefaultBranch = async function (owner, repo) {
   return resp.repository.defaultBranchRef.name
 }
 
-module.exports.getShas = async function getShas (owner, repo) {
+module.exports.getShas = async function getShas (owner, repo, sha) {
   const resp = await octokit.repos.listCommits({
     owner,
     repo,
+    sha,
     per_page: 1
   })
   const headSha = resp.data[0].sha
diff --git a/lib/graphql/getFiles.graphql b/lib/graphql/getFiles.graphql
@@ -0,0 +1,18 @@
+query($owner: String!, $repo: String!, $sha: String!) {
+  repository(name: $repo, owner: $owner) {
+    object(expression: $sha) {
+      ... on Commit {
+        tree {
+          entries {
+            name
+            object {
+              ... on Blob {
+                text
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/lib/graphql/getPackageJson.graphql b/lib/graphql/getPackageJson.graphql
diff --git a/lib/graphql/index.js b/lib/graphql/index.js
@@ -3,8 +3,8 @@
 const fs = require('fs')
 const path = require('path')
 
-exports.getPackageJson = fs.readFileSync(path.join(__dirname, 'getPackageJson.graphql')).toString()
+exports.getFiles = `${fs.readFileSync(path.join(__dirname, 'getFiles.graphql'))}`
 
-exports.getWibyBranches = fs.readFileSync(path.join(__dirname, 'getWibyBranches.graphql')).toString()
+exports.getWibyBranches = `${fs.readFileSync(path.join(__dirname, 'getWibyBranches.graphql'))}`
 
-exports.getDefaultBranch = fs.readFileSync(path.join(__dirname, 'getDefaultBranch.graphql')).toString()
+exports.getDefaultBranch = `${fs.readFileSync(path.join(__dirname, 'getDefaultBranch.graphql'))}`
diff --git a/lib/result.js b/lib/result.js
@@ -28,10 +28,9 @@ module.exports = async function ({ dependents }) {
   const allDependentsChecks = []
 
   debug(`Parent module: ${parentPkgInfo.owner}/${parentPkgJSON.name}`)
-
-  for (const { repository: url } of dependents) {
+  for (const { repository: url, sha } of dependents) {
     const dependentPkgInfo = gitURLParse(url)
-    const dependentPkgJSON = await github.getPackageJson(dependentPkgInfo.owner, dependentPkgInfo.name)
+    const dependentPkgJSON = await github.getPackageJson(dependentPkgInfo.owner, dependentPkgInfo.name, sha)
     debug(`Dependent module: ${dependentPkgInfo.owner}/${dependentPkgInfo.name}`)
 
     if (!context.checkDependentUsesParent(parentPkgJSON.name, dependentPkgJSON)) {
diff --git a/lib/test.js b/lib/test.js
@@ -21,17 +21,17 @@ module.exports = async function ({ dependents }) {
   const parentDependencyLink = await context.getDependencyLink(parentRepositoryInfo.owner, parentRepositoryInfo.name, parentBranchName)
   debug('Commit URL to test:', parentDependencyLink)
 
-  for (const { repository: url, pullRequest } of dependents) {
+  for (const { repository: url, pullRequest, sha } of dependents) {
     const dependentRepositoryInfo = gitURLParse(url)
-    const dependentPkgJson = await github.getPackageJson(dependentRepositoryInfo.owner, dependentRepositoryInfo.name)
-    debug(`Dependent module: ${dependentRepositoryInfo.owner}/${dependentRepositoryInfo.name}`)
+    const dependentPkgJson = await github.getPackageJson(dependentRepositoryInfo.owner, dependentRepositoryInfo.name, sha)
+    debug(`Dependent module: ${dependentRepositoryInfo.owner}/${dependentRepositoryInfo.name}, sha ${sha}`)
 
     if (!context.checkDependentUsesParent(parentPkgJSON.name, dependentPkgJson)) {
       throw new Error(`${parentRepositoryInfo.owner}/${parentPkgJSON.name} not found in the package.json of ${dependentRepositoryInfo.owner}/${dependentRepositoryInfo.name}`)
     }
 
     const patchedPackageJSON = applyPatch(parentDependencyLink, parentPkgJSON.name, dependentPkgJson, parentPkgJSON.name)
-    await pushPatch(patchedPackageJSON, dependentRepositoryInfo.owner, dependentRepositoryInfo.name, parentPkgJSON.name, parentBranchName)
+    await pushPatch(patchedPackageJSON, dependentRepositoryInfo.owner, dependentRepositoryInfo.name, parentPkgJSON.name, parentBranchName, sha)
     if (pullRequest) {
       await createPR(dependentRepositoryInfo.owner, dependentRepositoryInfo.name, parentBranchName, parentDependencyLink)
     }
@@ -48,7 +48,7 @@ function applyPatch (patch, module, dependentPkgJSON) {
   return dependentPkgJSON
 }
 
-async function pushPatch (dependentPkgJson, dependentOwner, dependentRepo, parentName, parentBranchName) {
+async function pushPatch (dependentPkgJson, dependentOwner, dependentRepo, parentName, parentBranchName, shaRef) {
   const file = JSON.stringify(dependentPkgJson, null, 2) + '\n' // assumes package.json is using two spaces
   const encodedFile = Buffer.from(file).toString('base64')
   const message = `wiby: update ${parentName}`
@@ -59,7 +59,7 @@ async function pushPatch (dependentPkgJson, dependentOwner, dependentRepo, paren
 
   if (!testingBranch) {
     // testing branch does not yet exist - create it
-    const { headSha, treeSha } = await github.getShas(dependentOwner, dependentRepo)
+    const { headSha, treeSha } = await github.getShas(dependentOwner, dependentRepo, shaRef)
     const newTreeSha = await github.createTree(dependentOwner, dependentRepo, treeSha, blobSha)
     const commitSha = await github.createCommit(dependentOwner, dependentRepo, message, newTreeSha, headSha)
     await github.createBranch(dependentOwner, dependentRepo, commitSha, testingBranchName)
diff --git a/test/cli/result.js b/test/cli/result.js
@@ -50,6 +50,28 @@ tap.test('result command', async (tap) => {
     }
   })
 
+  tap.test('result command should call result module with sha hash', async (tap) => {
+    const expected = fs.readFileSync(
+      path.join(__dirname, '..', 'fixtures', 'expected-outputs', 'result', 'result-output-single-dependant.md'),
+      'utf-8'
+    )
+      .trim()
+
+    try {
+      childProcess.execSync(`${wibyCommand} result --dependent="https://github.com/wiby-test/fakeRepo" --sha="fake"`, {
+        env: {
+          ...process.env,
+          NODE_OPTIONS: `-r ${fixturesPath}/http/result-command-positive-pass.js`
+        }
+      })
+    } catch (e) {
+      const result = e.output[1].toString().trim()
+
+      tap.equal(result, expected)
+      tap.equal(e.status, SUCCESS_RESULT_EXIT_CODE)
+    }
+  })
+
   tap.test('result command should call result module with all deps from .wiby.json', async (tap) => {
     const expected = fs.readFileSync(
       path.join(__dirname, '..', 'fixtures', 'expected-outputs', 'result', 'result-output-multiple-pass.md'),
diff --git a/test/cli/test.js b/test/cli/test.js
@@ -34,6 +34,19 @@ tap.test('test command', async (tap) => {
     tap.match(result, 'Changes pushed to https://github.com/wiby-test/fakeRepo/blob/wiby-running-unit-tests/package.json')
   })
 
+  tap.test('test command should call test module with sha hash', async (tap) => {
+    gitFixture.init()
+
+    const result = childProcess.execSync(`${wibyCommand} test --dependent="https://github.com/wiby-test/fakeRepo" --sha="fake"`, {
+      env: {
+        ...process.env,
+        NODE_OPTIONS: `-r ${fixturesPath}/http/test-command-positive.js`
+      }
+    }).toString()
+
+    tap.match(result, 'Changes pushed to https://github.com/wiby-test/fakeRepo/blob/wiby-running-unit-tests/package.json')
+  })
+
   tap.test('test command should call test module with all deps from .wiby.json', async (tap) => {
     gitFixture.init()
 
diff --git a/test/config.js b/test/config.js
@@ -35,15 +35,18 @@ tap.test('config validation', async (tap) => {
       dependents: [
         {
           repository: 'https://github.com/wiby-test/partial',
-          pullRequest: false
+          pullRequest: false,
+          sha: 'HEAD'
         },
         {
           repository: 'git://github.com/wiby-test/fail',
-          pullRequest: false
+          pullRequest: false,
+          sha: 'HEAD'
         },
         {
           repository: 'git+https://github.com/wiby-test/pass',
-          pullRequest: true
+          pullRequest: true,
+          sha: 'HEAD'
         }
       ]
     })
diff --git a/test/fixtures/http/result-command-empty-branch-checks-flat.js b/test/fixtures/http/result-command-empty-branch-checks-flat.js
@@ -14,11 +14,20 @@ nock('https://api.github.com')
     data: {
       repository: {
         object: {
-          text: JSON.stringify({
-            dependencies: {
-              wiby: '*'
-            }
-          })
+          tree: {
+            entries: [
+              {
+                name: 'package.json',
+                object: {
+                  text: JSON.stringify({
+                    dependencies: {
+                      wiby: '*'
+                    }
+                  })
+                }
+              }
+            ]
+          }
         }
       }
     }
diff --git a/test/fixtures/http/result-command-empty-branch-checks.js b/test/fixtures/http/result-command-empty-branch-checks.js
@@ -14,11 +14,20 @@ nock('https://api.github.com')
     data: {
       repository: {
         object: {
-          text: JSON.stringify({
-            dependencies: {
-              wiby: '*'
-            }
-          })
+          tree: {
+            entries: [
+              {
+                name: 'package.json',
+                object: {
+                  text: JSON.stringify({
+                    dependencies: {
+                      wiby: '*'
+                    }
+                  })
+                }
+              }
+            ]
+          }
         }
       }
     }
diff --git a/test/fixtures/http/result-command-missing-branch.js b/test/fixtures/http/result-command-missing-branch.js
@@ -15,11 +15,20 @@ nock('https://api.github.com')
     data: {
       repository: {
         object: {
-          text: JSON.stringify({
-            dependencies: {
-              wiby: '*'
-            }
-          })
+          tree: {
+            entries: [
+              {
+                name: 'package.json',
+                object: {
+                  text: JSON.stringify({
+                    dependencies: {
+                      wiby: '*'
+                    }
+                  })
+                }
+              }
+            ]
+          }
         }
       }
     }
diff --git a/test/fixtures/http/result-command-positive-checks-failed.js b/test/fixtures/http/result-command-positive-checks-failed.js
@@ -16,11 +16,20 @@ nock('https://api.github.com')
     data: {
       repository: {
         object: {
-          text: JSON.stringify({
-            dependencies: {
-              wiby: '*'
-            }
-          })
+          tree: {
+            entries: [
+              {
+                name: 'package.json',
+                object: {
+                  text: JSON.stringify({
+                    dependencies: {
+                      wiby: '*'
+                    }
+                  })
+                }
+              }
+            ]
+          }
         }
       }
     }
diff --git a/test/fixtures/http/result-command-positive-pass.js b/test/fixtures/http/result-command-positive-pass.js
diff --git a/test/fixtures/http/result-command-positive-pending.js b/test/fixtures/http/result-command-positive-pending.js
diff --git a/test/fixtures/http/test-command-positive.js b/test/fixtures/http/test-command-positive.js
diff --git a/test/internals/github-integration.js b/test/internals/github-integration.js
diff --git a/test/internals/github.js b/test/internals/github.js
diff --git a/test/result.js b/test/result.js
diff --git a/test/test.js b/test/test.js

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ const dependentSchema = joi.object({`
`14`	`14`	`'git+https'`
`15`	`15`	`]`
`16`	`16`	`}),`
`17`		`- pullRequest: joi.boolean().optional()`
	`17`	`+ pullRequest: joi.boolean().optional(),`
	`18`	`+ sha: joi.string().optional().default('HEAD')`
`18`	`19`	`}).unknown(false)`
`19`	`20`
`20`	`21`	`exports.schema = joi.object({`