Identify more platforms and externalize environment checking

.github/workflows/checkin.yml

@@ -1,4 +1,4 @@
-name: "Build and test Action"
+name: 'Build and test Action'
 on: [push, pull_request]
 
 jobs:
@@ -20,5 +20,5 @@ jobs:
       - run: npm run test:coverage
 
       - uses: codecov/codecov-action@v2
-      
+
       - run: npm audit

.github/workflows/e2e.yml

@@ -1,4 +1,4 @@
-name: "Create cluster using KinD"
+name: 'Create cluster using KinD'
 on: [pull_request, push]
 
 jobs:
@@ -15,8 +15,12 @@ jobs:
 
       - run: npm run build
 
-      - name: "Run engineerd/setup-kind@${{github.sha}}"
+      - name: 'Run engineerd/setup-kind@${{github.sha}}'
         uses: ./
+        with:
+          image: kindest/node:v1.21.1@sha256:69860bda5563ac81e3c0057d654b5253219618a22ec3a346306239bba8cfa1a6
+          loadBalancer: true
+          localRegistry: true
 
       - run: kubectl cluster-info
 

.gitignore

@@ -2,4 +2,5 @@ node_modules/
 __tests__/runner/*
 lib/
 dist/
-coverage/
+coverage/
+.vscode/

.prettierrc.json

@@ -1,4 +1,5 @@
 {
   "endOfLine": "auto",
+  "printWidth": 100,
   "singleQuote": true
-}
+}

README.md

@@ -32,8 +32,6 @@ jobs:
 > version 0.6 of Kind. See [this document for a detailed migration
 > guide][kind-kubeconfig]
 
-> Note: GitHub Actions workers come pre-configured with `kubectl`.
-
 The following arguments can be configured on the job using the `with` keyword
 (see example above). Currently, possible inputs are all the flags for
 `kind cluster create`, with the additional version, which sets the Kind version
@@ -55,6 +53,8 @@ Optional inputs:
 - `skipClusterLogsExport`: if `"true"`, the action will not export the cluster logs
 - `verbosity`: numeric log verbosity, (info = 0, debug = 3, trace = 2147483647) (default `"0"`)
 - `quiet`: silence all stderr output (default `"false"`)
+- `loadBalancer`: setup a Metallb load-balancer (default `"false"`)
+- `localRegistry`: setup a local registry on localhost:5000 (default `"false"`)
 
 Example using optional inputs:
 
@@ -78,6 +78,26 @@ jobs:
           echo "environment-kubeconfig:" ${KUBECONFIG}
 ```
 
+## Kubectl
+
+GitHub Actions workers come pre-configured with `kubectl` but if the Kubernetes version can be identified from the image
+input or the images of the nodes in the config file, it will be installed in the tool-cache with the right version.
+
+## Load-balancer
+
+When `loadBalancer: true` a load-balancer is created based on <https://kind.sigs.k8s.io/docs/user/loadbalancer/>
+
+## Local registry
+
+When `localRegistry: true` a local registry is created based on <https://kind.sigs.k8s.io/docs/user/local-registry/>
+It is then available on localhost:5000 as KIND_REGISTRY on the host machine
+
+## Self-hosted agents
+
+When using on a self-hosted agent, an access to GITHUB_API_URL (<https://api.github.com> by default) and <https://storage.googleapis.com> are required for setup-kind to work properly.
+
+NB: The load-balancer needs an access to <https://raw.githubusercontent.com>
+
 [kind-kubeconfig]: https://github.com/kubernetes-sigs/kind/issues/1060
 [gh-actions-path]:
   https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/

__tests__/go.test.ts

@@ -1,11 +1,11 @@
-import * as go from '../src/go';
+import { env as goenv } from '../src/go';
 
 describe('checking go env simulation', function () {
   it('correctly parse os', () => {
-    expect(['windows', 'darwin', 'linux']).toContain(go.goos());
+    expect(['windows', 'darwin', 'linux']).toContain(goenv.GOOS);
   });
 
   it('correctly parse arch', () => {
-    expect(['amd64', 'arm64']).toContain(go.goarch());
+    expect(['amd64', 'arm64']).toContain(goenv.GOARCH);
   });
 });

__tests__/kind/main.test.ts

@@ -4,7 +4,6 @@ import { KindMainService } from '../../src/kind/main';
 const testEnvVars = {
   INPUT_VERBOSITY: '3',
   INPUT_QUIET: 'true',
-  INPUT_VERSION: 'v0.5.3',
   INPUT_CONFIG: 'some-path',
   INPUT_IMAGE: 'some-docker-image',
   INPUT_NAME: 'some-name',
@@ -30,7 +29,6 @@ describe('checking input parsing', function () {
 
   it('correctly parse input', () => {
     const service: KindMainService = KindMainService.getInstance();
-    expect(service.version).toEqual(testEnvVars.INPUT_VERSION);
     expect(service.configFile).toEqual(testEnvVars.INPUT_CONFIG);
     expect(service.image).toEqual(testEnvVars.INPUT_IMAGE);
     expect(service.name).toEqual(testEnvVars.INPUT_NAME);
@@ -46,14 +44,13 @@ describe('checking input parsing', function () {
   });
 
   it('correctly generates the cluster create command', () => {
-    const args: string[] = KindMainService.getInstance().createCommand();
+    const args: string[] = KindMainService.getInstance().createCommand('');
     expect(args).toEqual([
       'create',
       'cluster',
       '--verbosity',
       testEnvVars.INPUT_VERBOSITY,
       '--quiet',
-      testEnvVars.INPUT_QUIET,
       '--config',
       path.normalize('/home/runner/repo/some-path'),
       '--image',

__tests__/kind/post.test.ts

@@ -45,7 +45,6 @@ describe('checking input parsing', function () {
       '--verbosity',
       testEnvVars.INPUT_VERBOSITY,
       '--quiet',
-      testEnvVars.INPUT_QUIET,
       '--name',
       testEnvVars.INPUT_NAME,
       '--kubeconfig',
@@ -54,17 +53,18 @@ describe('checking input parsing', function () {
   });
 
   it('correctly generates the cluster export logs command', () => {
-    const args: string[] = KindPostService.getInstance().exportLogsCommand();
+    const logsDir = KindPostService.getInstance().kindLogsDir();
+    expect(logsDir).toEqual(
+      path.normalize('/home/runner/work/_temp/1c1900ec-8f4f-5069-a966-1d3072cc9723')
+    );
+    const args: string[] = KindPostService.getInstance().exportLogsCommand(logsDir);
     expect(args).toEqual([
       'export',
       'logs',
-      path.normalize(
-        '/home/runner/work/_temp/1c1900ec-8f4f-5069-a966-1d3072cc9723'
-      ),
+      path.normalize('/home/runner/work/_temp/1c1900ec-8f4f-5069-a966-1d3072cc9723'),
       '--verbosity',
       testEnvVars.INPUT_VERBOSITY,
       '--quiet',
-      testEnvVars.INPUT_QUIET,
       '--name',
       testEnvVars.INPUT_NAME,
     ]);

__tests__/local-registry.test.ts

@@ -0,0 +1,23 @@
+import { hasRegistryConfig } from '../src/local-registry';
+
+describe('checking registry validation', function () {
+  it('disable_tcp_service configuration', () => {
+    const configPatch = `[plugins."io.containerd.grpc.v1.cri"]
+      disable_tcp_service = true`;
+    expect(hasRegistryConfig(configPatch)).toBeFalsy();
+  });
+  it('empty configuration', () => {
+    const configPatch = ``;
+    expect(hasRegistryConfig(configPatch)).toBeFalsy();
+  });
+  it('wrong port', () => {
+    const configPatch = `[plugins."io.containerd.grpc.v1.cri".registry.mirrors."localhost:5001"]
+    endpoint = ["http://kind-registry:5000"]`;
+    expect(hasRegistryConfig(configPatch)).toBeFalsy();
+  });
+  it('correctly configured', () => {
+    const configPatch = `[plugins."io.containerd.grpc.v1.cri".registry.mirrors."localhost:5000"]
+    endpoint = ["http://kind-registry:5000"]`;
+    expect(hasRegistryConfig(configPatch)).toBeTruthy();
+  });
+});

__tests__/requirements.test.ts

@@ -0,0 +1,31 @@
+import { checkEnvironment } from '../src/requirements';
+
+const testEnvVars = {
+  INPUT_VERSION: 'v0.7.0',
+  GITHUB_JOB: 'kind',
+  GITHUB_WORKSPACE: '/home/runner/repo',
+  RUNNER_OS: 'Linux',
+  RUNNER_ARCH: 'X64',
+  RUNNER_TEMP: '/home/runner/work/_temp',
+  RUNNER_TOOL_CACHE: '/opt/hostedtoolcache',
+};
+
+describe('checking requirements', function () {
+  const originalEnv = process.env;
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = {
+      ...originalEnv,
+      ...testEnvVars,
+    };
+  });
+
+  afterEach(() => {
+    process.env = originalEnv;
+  });
+
+  it('required GITHUB_JOB must be defined', async () => {
+    process.env['GITHUB_JOB'] = '';
+    await expect(checkEnvironment()).rejects.toThrow('Expected GITHUB_JOB to be defined');
+  });
+});

action.yml

@@ -1,41 +1,51 @@
-name: "KinD (Kubernetes in Docker) Action"
-description: "Easily run a Kubernetes cluster in your GitHub Action"
-author: "Engineerd"
+name: 'KinD (Kubernetes in Docker) Action'
+description: 'Easily run a Kubernetes cluster in your GitHub Action'
+author: 'Engineerd'
 inputs:
   version:
-    description: "Version of Kind to use (default v0.11.1)"
-    default: "v0.11.1"
+    description: 'Version of Kind to use (default v0.11.1)'
+    default: 'v0.11.1'
     required: true
   config:
-    description: "Path (relative to the root of the repository) to a kind config file"
+    description: 'Path (relative to the root of the repository) to a kind config file'
   image:
-    description: "Node Docker image to use for booting the cluster"
+    description: 'Node Docker image to use for booting the cluster'
   name:
-    description: "Cluster name (default kind)"
-    default: "kind"
+    description: 'Cluster name (default kind)'
+    default: 'kind'
     required: true
   wait:
-    description: "Wait for control plane node to be ready (default 300s)"
-    default: "300s"
+    description: 'Wait for control plane node to be ready (default 300s)'
+    default: '300s'
   kubeconfig:
-    description: "Sets kubeconfig path instead of $KUBECONFIG or $HOME/.kube/config"
+    description: 'Sets kubeconfig path instead of $KUBECONFIG or $HOME/.kube/config'
   skipClusterCreation:
-    description: "If true, the action will not create a cluster, just acquire the tools"
-    default: "false"
+    description: 'If true, the action will not create a cluster, just acquire the tools'
+    default: 'false'
   skipClusterDeletion:
-    description: "If true, the action will not delete the cluster"
-    default: "false"
+    description: 'If true, the action will not delete the cluster'
+    default: 'false'
   skipClusterLogsExport:
-    description: "If true, the action will not export the cluster logs"
-    default: "false"
+    description: 'If true, the action will not export the cluster logs'
+    default: 'false'
   verbosity:
-    description: "Defines log verbosity with a numeric value, (info = 0, debug = 3, trace = 2147483647)"
-    default: "0"
+    description: 'Defines log verbosity with a numeric value, (info = 0, debug = 3, trace = 2147483647)'
+    default: '0'
   quiet:
-    description: "Silence all stderr output"
-    default: "false"
+    description: 'Silence all stderr output'
+    default: 'false'
+  token:
+    description: 'Used to retrieve release informations concerning KinD and Kubernetes from https://api.github.com'
+    default: '${{ github.token }}'
+    required: true
+  loadBalancer:
+    description: 'Setup a Metallb load-balancer'
+    default: 'false'
+  localRegistry:
+    description: 'Setup a local registry on localhost:5000'
+    default: 'false'
 runs:
-  using: "node12"
-  main: "dist/main/index.js"
-  post: "dist/post/index.js"
+  using: 'node12'
+  main: 'dist/main/index.js'
+  post: 'dist/post/index.js'
   post-if: success()