e2e: add performance test

Add a test that captures timing measurements (in 'console.log()' printouts)
for cloning various large repositories. The tests are divided into two
example sets: one for tests that run on modern hardware with a good internet
connection for a *total* of less than 15 minutes (currently take ~7
minutes), and the other for tests that take longer than that. The latter set
is tagged with '@slow' and the 'default' profile is updated to skip them.
Add an 'all' profile that runs these slow performance tests alongside the
"regular" tests.

Helped-by: Derrick Stolee <[email protected]>
Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

test/e2e/cucumber.js

@@ -1,16 +1,24 @@
+const common = {
+  requireModule: ['ts-node/register'],
+  require: ['features/**/*.ts'],
+  publishQuiet: true,
+  format: ['progress'],
+  formatOptions: {
+    snippetInterface: 'async-await'
+  },
+  worldParameters: {
+    bundleServerCommand: '../../bin/git-bundle-server',
+    bundleWebServerCommand: '../../bin/git-bundle-web-server',
+    trashDirectoryBase: '../../_test/e2e'
+  }
+}
+
 module.exports = {
   default: {
-    requireModule: ['ts-node/register'],
-    require: ['features/**/*.ts'],
-    publishQuiet: true,
-    format: ['progress'],
-    formatOptions: {
-      snippetInterface: 'async-await'
-    },
-    worldParameters: {
-      bundleServerCommand: '../../bin/git-bundle-server',
-      bundleWebServerCommand: '../../bin/git-bundle-web-server',
-      trashDirectoryBase: '../../_test/e2e'
-    }
+    ...common,
+    tags: 'not @slow',
+  },
+  all: {
+    ...common
   }
 }

test/e2e/features/classes/repository.ts

@@ -8,6 +8,7 @@ export class ClonedRepository {
   private remote: RemoteRepo | undefined
 
   cloneResult: child_process.SpawnSyncReturns<Buffer>
+  cloneTimeMs: number
 
   constructor(remote: RemoteRepo, root: string, bundleUri?: string) {
     this.initialized = false
@@ -21,7 +22,9 @@ export class ClonedRepository {
     }
     args.push(this.remote.remoteUri, this.root)
 
+    const timer = performance.now()
     this.cloneResult = child_process.spawnSync("git", args)
+    this.cloneTimeMs = performance.now() - timer
     if (!this.cloneResult.error) {
       this.initialized = true
     }

test/e2e/features/performance.feature

@@ -0,0 +1,22 @@
+Feature: Bundle server performance
+
+  Background: The bundle web server is running
+    Given the bundle web server was started at port 8080
+
+  Scenario Outline: Comparing clone performance
+    Given a remote repository '<repo>'
+    Given the bundle server has been initialized with the remote repo
+    When I clone from the remote repo with a bundle URI
+    When another developer clones from the remote repo without a bundle URI
+    Then I compare the clone execution times
+
+    Examples:
+      | repo                                         |
+      | https://github.com/git/git.git               |
+      | https://github.com/kubernetes/kubernetes.git |
+
+    @slow
+    Examples:
+      | repo                                      |
+      | https://github.com/homebrew/homebrew-core |
+      | https://github.com/torvalds/linux.git     |

test/e2e/features/step_definitions/repository.ts

@@ -50,6 +50,10 @@ When('I clone from the remote repo with a bundle URI', async function (this: Bun
   this.cloneRepositoryFor(User.Me, this.bundleServer.bundleUri())
 })
 
+When('another developer clones from the remote repo without a bundle URI', async function (this: BundleServerWorld) {
+  this.cloneRepositoryFor(User.Another)
+})
+
 When('I fetch from the remote', async function (this: BundleServerWorld) {
   const clonedRepo = this.getRepo(User.Me)
   utils.assertStatus(0, clonedRepo.runGit("fetch", "origin"))
@@ -107,3 +111,14 @@ Then('my repo\'s bundles {boolean} up-to-date with {string}',
     }
   }
 )
+
+Then('I compare the clone execution times', async function (this: BundleServerWorld) {
+  const myClone = this.getRepo(User.Me)
+  const otherClone = this.getRepo(User.Another)
+
+  // Verify the clones succeeded
+  utils.assertStatus(0, myClone.cloneResult)
+  utils.assertStatus(0, otherClone.cloneResult)
+
+  console.log(`\nClone execution time for ${this.remote!.remoteUri}: ${(myClone.cloneTimeMs / 1000).toFixed(2)}s (bundle URI) vs. ${(otherClone.cloneTimeMs / 1000).toFixed(2)}s (no bundle URI)`)
+})