feat: add mode option for dependents and update test logic

Author: bjohansebas

.wiby.json

@@ -2,15 +2,18 @@
   "dependents": [
     {
       "repository": "https://github.com/wiby-test/partial",
-      "pullRequest": false
+      "pullRequest": false,
+      "mode": "download"
     },
     {
       "repository": "git://github.com/wiby-test/fail",
-      "pullRequest": false
+      "pullRequest": false,
+      "mode": "download"
     },
     {
       "repository": "git+https://github.com/wiby-test/pass",
-      "pullRequest": true
+      "pullRequest": true,
+      "mode": "download"
     }
   ]
 }

bin/commands/test.js

@@ -18,7 +18,8 @@ exports.builder = (yargs) => yargs
   })
   .option('sha', {
     desc: 'Test against a specific commit or branch',
-    type: 'string'})
+    type: 'string'
+  })
   .option('mode', {
     desc: 'Choose the mode in which the package will be tested',
     type: 'string',

lib/test.js

@@ -3,7 +3,11 @@
 const context = require('./context')
 const github = require('./github')
 const gitURLParse = require('git-url-parse')
+const { exec } = require('child_process')
 const logger = require('./logger')
+const tmp = require('tmp')
+const { cp } = require('fs/promises')
+const path = require('path')
 
 // setup logger namespace
 const testCommandNamespace = 'wiby:test'
@@ -21,19 +25,33 @@ 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, sha } of dependents) {
+  for (const { repository: url, pullRequest, sha, mode } of dependents) {
     const dependentRepositoryInfo = gitURLParse(url)
-    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, sha)
-    if (pullRequest) {
-      await createPR(dependentRepositoryInfo.owner, dependentRepositoryInfo.name, parentBranchName, parentDependencyLink)
+    if (mode === 'download') {
+      debug('Generating tarball')
+      exec('npm pack')
+      const { name: tmpDir } = tmp.dirSync()
+
+      debug(`Temporary directory: ${tmpDir}`)
+      debug(`Copying package to ${tmpDir}`)
+      cp(`${parentPkgJSON.name}-${parentPkgJSON.version}.tgz`, path.join(tmpDir, `${parentPkgJSON.name}-${parentPkgJSON.version}.tgz`))
+
+      debug(`Cloning dependent repository ${url} into ${tmpDir}`)
+      exec(`git clone ${url} ${tmpDir}`, { cwd: tmpDir })
+    } else {
+      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, sha)
+      if (pullRequest) {
+        await createPR(dependentRepositoryInfo.owner, dependentRepositoryInfo.name, parentBranchName, parentDependencyLink)
+      }
     }
   }
 }

package.json

@@ -36,15 +36,15 @@
     "dotenv": "^16.0.0",
     "git-url-parse": "^11.1.2",
     "joi": "^17.2.1",
+    "simple-git": "~3.15.0",
+    "tmp": "^0.2.1",
     "yargs": "^17.0.0"
   },
   "devDependencies": {
     "nock": "^13.0.3",
     "semver": "^7.7.1",
-    "simple-git": "~3.15.0",
     "standard": "^16.0.0",
-    "tap": "^16.0.0",
-    "tmp": "^0.2.1"
+    "tap": "^16.0.0"
   },
   "standard": {
     "ignore": [

test/config.js

@@ -37,19 +37,19 @@ tap.test('config validation', async (tap) => {
           repository: 'https://github.com/wiby-test/partial',
           pullRequest: false,
           sha: 'HEAD',
-          mode: "pull-request"
+          mode: 'pull-request'
         },
         {
           repository: 'git://github.com/wiby-test/fail',
           pullRequest: false,
           sha: 'HEAD',
-          mode: "pull-request"
+          mode: 'pull-request'
         },
         {
           repository: 'git+https://github.com/wiby-test/pass',
           pullRequest: true,
           sha: 'HEAD',
-          mode: "pull-request"
+          mode: 'pull-request'
         }
       ]
     })