fixed merge conflict, repaired paths in examples

2025-12-14 00:26:44 +00:00 · 2022-06-08 11:02:33 +02:00
parent d0e094649e ecb9376000
commit 02f0b322a0
23 changed files with 300 additions and 114 deletions
--- a/packages/k8s/tests/cleanup-job-test.ts
+++ b/packages/k8s/tests/cleanup-job-test.ts
@@ -1,9 +1,9 @@
 import * as path from 'path'
 import * as fs from 'fs'
 import { prepareJob, cleanupJob } from '../src/hooks'
-import { TestTempOutput } from './test-setup'
+import { TestHelper } from './test-setup'

-let testTempOutput: TestTempOutput
+let testHelper: TestHelper

 const prepareJobJsonPath = path.resolve(
  `${__dirname}/../../../examples/prepare-job.json`
@@ -16,16 +16,15 @@ describe('Cleanup Job', () => {
    const prepareJobJson = fs.readFileSync(prepareJobJsonPath)
    let prepareJobData = JSON.parse(prepareJobJson.toString())

-    testTempOutput = new TestTempOutput()
-    testTempOutput.initialize()
-    prepareJobOutputFilePath = testTempOutput.createFile(
-      'prepare-job-output.json'
-    )
+    testHelper = new TestHelper()
+    await testHelper.initialize()
+    prepareJobOutputFilePath = testHelper.createFile('prepare-job-output.json')
    await prepareJob(prepareJobData.args, prepareJobOutputFilePath)
  })
  it('should not throw', async () => {
-    const outputJson = fs.readFileSync(prepareJobOutputFilePath)
-    const outputData = JSON.parse(outputJson.toString())
    await expect(cleanupJob()).resolves.not.toThrow()
  })
+  afterEach(async () => {
+    await testHelper.cleanup()
+  })
 })
--- a/packages/k8s/tests/e2e-test.ts
+++ b/packages/k8s/tests/e2e-test.ts
@@ -6,38 +6,36 @@ import {
  runContainerStep,
  runScriptStep
 } from '../src/hooks'
-import { TestTempOutput } from './test-setup'
+import { TestHelper } from './test-setup'

 jest.useRealTimers()

-let testTempOutput: TestTempOutput
+let testHelper: TestHelper

 const prepareJobJsonPath = path.resolve(
-  `${__dirname}/../../../../examples/prepare-job.json`
+  `${__dirname}/../../../examples/prepare-job.json`
 )
 const runScriptStepJsonPath = path.resolve(
-  `${__dirname}/../../../../examples/run-script-step.json`
+  `${__dirname}/../../../examples/run-script-step.json`
 )
 let runContainerStepJsonPath = path.resolve(
-  `${__dirname}/../../../../examples/run-container-step.json`
+  `${__dirname}/../../../examples/run-container-step.json`
 )

 let prepareJobData: any

 let prepareJobOutputFilePath: string
 describe('e2e', () => {
-  beforeEach(() => {
+  beforeEach(async () => {
    const prepareJobJson = fs.readFileSync(prepareJobJsonPath)
    prepareJobData = JSON.parse(prepareJobJson.toString())

-    testTempOutput = new TestTempOutput()
-    testTempOutput.initialize()
-    prepareJobOutputFilePath = testTempOutput.createFile(
-      'prepare-job-output.json'
-    )
+    testHelper = new TestHelper()
+    await testHelper.initialize()
+    prepareJobOutputFilePath = testHelper.createFile('prepare-job-output.json')
  })
  afterEach(async () => {
-    testTempOutput.cleanup()
+    await testHelper.cleanup()
  })
  it('should prepare job, run script step, run container step then cleanup without errors', async () => {
    await expect(
--- a/packages/k8s/tests/prepare-job-test.ts
+++ b/packages/k8s/tests/prepare-job-test.ts
@@ -2,11 +2,11 @@ import * as fs from 'fs'
 import * as path from 'path'
 import { cleanupJob } from '../src/hooks'
 import { prepareJob } from '../src/hooks/prepare-job'
-import { TestTempOutput } from './test-setup'
+import { TestHelper } from './test-setup'

 jest.useRealTimers()

-let testTempOutput: TestTempOutput
+let testHelper: TestHelper

 const prepareJobJsonPath = path.resolve(
  `${__dirname}/../../../examples/prepare-job.json`
@@ -16,21 +16,17 @@ let prepareJobData: any
 let prepareJobOutputFilePath: string

 describe('Prepare job', () => {
-  beforeEach(() => {
+  beforeEach(async () => {
    const prepareJobJson = fs.readFileSync(prepareJobJsonPath)
    prepareJobData = JSON.parse(prepareJobJson.toString())

-    testTempOutput = new TestTempOutput()
-    testTempOutput.initialize()
-    prepareJobOutputFilePath = testTempOutput.createFile(
-      'prepare-job-output.json'
-    )
+    testHelper = new TestHelper()
+    await testHelper.initialize()
+    prepareJobOutputFilePath = testHelper.createFile('prepare-job-output.json')
  })
  afterEach(async () => {
-    const outputJson = fs.readFileSync(prepareJobOutputFilePath)
-    const outputData = JSON.parse(outputJson.toString())
    await cleanupJob()
-    testTempOutput.cleanup()
+    await testHelper.cleanup()
  })

  it('should not throw exception', async () => {
--- a/packages/k8s/tests/run-container-step-test.ts
+++ b/packages/k8s/tests/run-container-step-test.ts
@@ -1,11 +1,11 @@
-import { TestTempOutput } from './test-setup'
+import * as fs from 'fs'
 import * as path from 'path'
 import { runContainerStep } from '../src/hooks'
-import * as fs from 'fs'
+import { TestHelper } from './test-setup'

 jest.useRealTimers()

-let testTempOutput: TestTempOutput
+let testHelper: TestHelper

 let runContainerStepJsonPath = path.resolve(
  `${__dirname}/../../../examples/run-container-step.json`
@@ -14,14 +14,18 @@ let runContainerStepJsonPath = path.resolve(
 let runContainerStepData: any

 describe('Run container step', () => {
-  beforeAll(() => {
+  beforeAll(async () => {
    const content = fs.readFileSync(runContainerStepJsonPath)
    runContainerStepData = JSON.parse(content.toString())
-    process.env.RUNNER_NAME = 'testjob'
+    testHelper = new TestHelper()
+    await testHelper.initialize()
  })
  it('should not throw', async () => {
    await expect(
      runContainerStep(runContainerStepData.args)
    ).resolves.not.toThrow()
  })
+  afterEach(async () => {
+    await testHelper.cleanup()
+  })
 })
--- a/packages/k8s/tests/run-script-step-test.ts
+++ b/packages/k8s/tests/run-script-step-test.ts
@@ -1,11 +1,11 @@
 import { prepareJob, cleanupJob, runScriptStep } from '../src/hooks'
-import { TestTempOutput } from './test-setup'
+import { TestHelper } from './test-setup'
 import * as path from 'path'
 import * as fs from 'fs'

 jest.useRealTimers()

-let testTempOutput: TestTempOutput
+let testHelper: TestHelper

 const prepareJobJsonPath = path.resolve(
  `${__dirname}/../../../examples/prepare-job.json`
@@ -19,13 +19,10 @@ describe('Run script step', () => {
  beforeEach(async () => {
    const prepareJobJson = fs.readFileSync(prepareJobJsonPath)
    prepareJobData = JSON.parse(prepareJobJson.toString())
-    console.log(prepareJobData)

-    testTempOutput = new TestTempOutput()
-    testTempOutput.initialize()
-    prepareJobOutputFilePath = testTempOutput.createFile(
-      'prepare-job-output.json'
-    )
+    testHelper = new TestHelper()
+    await testHelper.initialize()
+    prepareJobOutputFilePath = testHelper.createFile('prepare-job-output.json')
    await prepareJob(prepareJobData.args, prepareJobOutputFilePath)
    const outputContent = fs.readFileSync(prepareJobOutputFilePath)
    prepareJobOutputData = JSON.parse(outputContent.toString())
@@ -33,7 +30,7 @@ describe('Run script step', () => {

  afterEach(async () => {
    await cleanupJob()
-    testTempOutput.cleanup()
+    await testHelper.cleanup()
  })

  // NOTE: To use this test, do kubectl apply -f podspec.yaml (from podspec examples)
@@ -42,8 +39,8 @@ describe('Run script step', () => {

  it('should not throw an exception', async () => {
    const args = {
-      entryPointArgs: ['echo "test"'],
-      entryPoint: '/bin/bash',
+      entryPointArgs: ['-c', 'echo "test"'],
+      entryPoint: 'bash',
      environmentVariables: {
        NODE_ENV: 'development'
      },
--- a/packages/k8s/tests/test-setup.ts
+++ b/packages/k8s/tests/test-setup.ts
@@ -1,20 +1,69 @@
+import * as k8s from '@kubernetes/client-node'
 import * as fs from 'fs'
 import { v4 as uuidv4 } from 'uuid'

-export class TestTempOutput {
+const kc = new k8s.KubeConfig()
+
+kc.loadFromDefault()
+
+const k8sApi = kc.makeApiClient(k8s.CoreV1Api)
+const k8sStorageApi = kc.makeApiClient(k8s.StorageV1Api)
+
+export class TestHelper {
  private tempDirPath: string
+  private podName: string
  constructor() {
-    this.tempDirPath = `${__dirname}/_temp/${uuidv4()}`
+    this.tempDirPath = `${__dirname}/_temp/runner`
+    this.podName = uuidv4().replace(/-/g, '')
  }

-  public initialize(): void {
-    fs.mkdirSync(this.tempDirPath, { recursive: true })
+  public async initialize(): Promise<void> {
+    process.env['ACTIONS_RUNNER_POD_NAME'] = `${this.podName}`
+    process.env['ACTIONS_RUNNER_CLAIM_NAME'] = `${this.podName}-work`
+    process.env['RUNNER_WORKSPACE'] = `${this.tempDirPath}/work/repo`
+    process.env['GITHUB_WORKSPACE'] = `${this.tempDirPath}/work/repo/repo`
+    process.env['ACTIONS_RUNNER_KUBERNETES_NAMESPACE'] = 'default'
+
+    await this.cleanupK8sResources()
+    try {
+      await this.createTestVolume()
+      await this.createTestJobPod()
+    } catch {}
+    fs.mkdirSync(`${this.tempDirPath}/work/repo/repo`, { recursive: true })
+    fs.mkdirSync(`${this.tempDirPath}/externals`, { recursive: true })
  }

-  public cleanup(): void {
-    fs.rmSync(this.tempDirPath, { recursive: true })
+  public async cleanup(): Promise<void> {
+    try {
+      await this.cleanupK8sResources()
+      fs.rmSync(this.tempDirPath, { recursive: true })
+    } catch {}
+  }
+  public async cleanupK8sResources() {
+    await k8sApi
+      .deleteNamespacedPersistentVolumeClaim(
+        `${this.podName}-work`,
+        'default',
+        undefined,
+        undefined,
+        0
+      )
+      .catch(e => {})
+    await k8sApi.deletePersistentVolume(`${this.podName}-pv`).catch(e => {})
+    await k8sStorageApi.deleteStorageClass('local-storage').catch(e => {})
+    await k8sApi
+      .deleteNamespacedPod(this.podName, 'default', undefined, undefined, 0)
+      .catch(e => {})
+    await k8sApi
+      .deleteNamespacedPod(
+        `${this.podName}-workflow`,
+        'default',
+        undefined,
+        undefined,
+        0
+      )
+      .catch(e => {})
  }
-
  public createFile(fileName?: string): string {
    const filePath = `${this.tempDirPath}/${fileName || uuidv4()}`
    fs.writeFileSync(filePath, '')
@@ -25,4 +74,69 @@ export class TestTempOutput {
    const filePath = `${this.tempDirPath}/${fileName}`
    fs.rmSync(filePath)
  }
+
+  public async createTestJobPod() {
+    const container = {
+      name: 'nginx',
+      image: 'nginx:latest',
+      imagePullPolicy: 'IfNotPresent'
+    } as k8s.V1Container
+
+    const pod: k8s.V1Pod = {
+      metadata: {
+        name: this.podName
+      },
+      spec: {
+        restartPolicy: 'Never',
+        containers: [container]
+      }
+    } as k8s.V1Pod
+    await k8sApi.createNamespacedPod('default', pod)
+  }
+
+  public async createTestVolume() {
+    var sc: k8s.V1StorageClass = {
+      metadata: {
+        name: 'local-storage'
+      },
+      provisioner: 'kubernetes.io/no-provisioner',
+      volumeBindingMode: 'Immediate'
+    }
+    await k8sStorageApi.createStorageClass(sc)
+
+    var volume: k8s.V1PersistentVolume = {
+      metadata: {
+        name: `${this.podName}-pv`
+      },
+      spec: {
+        storageClassName: 'local-storage',
+        capacity: {
+          storage: '2Gi'
+        },
+        volumeMode: 'Filesystem',
+        accessModes: ['ReadWriteOnce'],
+        hostPath: {
+          path: this.tempDirPath
+        }
+      }
+    }
+    await k8sApi.createPersistentVolume(volume)
+    var volumeClaim: k8s.V1PersistentVolumeClaim = {
+      metadata: {
+        name: `${this.podName}-work`
+      },
+      spec: {
+        accessModes: ['ReadWriteOnce'],
+        volumeMode: 'Filesystem',
+        storageClassName: 'local-storage',
+        volumeName: `${this.podName}-pv`,
+        resources: {
+          requests: {
+            storage: '1Gi'
+          }
+        }
+      }
+    }
+    await k8sApi.createNamespacedPersistentVolumeClaim('default', volumeClaim)
+  }
 }