Merge pull request #20 from marcofranssen/add-plugin-install

Add feature to install krew plugins

.github/workflows/test-kubectl-action.yaml

@@ -43,7 +43,7 @@ jobs:
       matrix:
         # os: [ubuntu-22.04, macos-12, windows-2022]
         os: [ubuntu-22.04, macos-12]
-        version: [v1.24.4, latest, stable]
+        version: [v1.23.12, v1.24.6, stable, latest]
         enablePlugins: [true, false]
 
     runs-on: ${{ matrix.os }}
@@ -71,6 +71,7 @@ jobs:
         with:
           kubectlVersion: ${{ matrix.version }}
           enablePlugins: ${{ matrix.enablePlugins }}
+          plugins: aws-auth grep
 
       - name: Check output and installPath
         run: |
@@ -80,7 +81,12 @@ jobs:
           ${{ matrix.enablePlugins }} && {
             hash kubectl-krew 2>/dev/null || { echo >&2 "kubectl-krew can not be found in the PATH."; exit 1; }
             echo "::notice::Installed krew ${KREW_VERSION} at $(which kubectl-krew)"
+            ls -ahl /$HOME/.krew/bin
+            echo "::notice::Installed following plugins $KREW_PLUGINS"
+            hash kubectl-aws_auth 2>/dev/null || { echo >&2 "aws-auth plugin can not be found in PATH."; exit 1; }
+            hash kubectl-grep 2>/dev/null || { echo >&2 "grep plugin can not be found in PATH."; exit 1; }
           } || true
         env:
           KUBECTL_VERSION: ${{ steps.setup-kubectl.outputs.kubectl-version }}
           KREW_VERSION: ${{ steps.setup-kubectl.outputs.krew-version }}
+          KREW_PLUGINS: ${{ steps.setup-kubectl.outputs.krew-plugins }}

README.md

@@ -53,6 +53,20 @@ steps:
   - run: kubectl krew install aws-auth
 ```
 
+### Install plugins
+
+Install `krew` allong with `kubectl` and some plugins.
+
+```yaml
+steps:
+  - uses: marcofranssen/setup-kubectl@v0.1.0
+    with:
+      enable-plugins: true
+      plugins: aws-auth,grep
+  - run: echo ${{ steps.kubectl.output.krew-version }}
+  - run: echo ${{ fromJson(steps.kubectl.output.krew-plugins) }}
+  - run: kubectl aws-auth version
+```
 
 [kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/ "The Kubernetes CLI"
 [krew]: https://krew.sigs.k8s.io/ "Krew is the plugin manager for kubectl command-line tool."

action.yml

@@ -15,11 +15,18 @@ inputs:
       Install krew to manage kubectl plugins (defaults to false).
     required: false
     default: 'false'
+  plugins:
+    description: >-
+      Install the given plugins (comma or space separated).
+    required: false
+    default: ''
 outputs:
   kubectl-version:
     description: 'The kubectl version that was installed.'
   krew-version:
     description: 'The krew version that was installed.'
+  krew-plugins:
+    description: 'The list of installed plugins (json serialized object).'
 runs:
   using: 'node16'
   main: 'dist/index.js'

lib/krew.ts

@@ -4,7 +4,7 @@ import * as tc from "@actions/tool-cache";
 import { mapOS, mapArch, download } from "./utils";
 import { exec } from "child_process";
 
-export async function setupKrew() {
+export async function setupKrew(plugins: string[]) {
   const osPlatform = platform();
   const osArch = arch();
   const p = mapOS(osPlatform);
@@ -27,8 +27,10 @@ export async function setupKrew() {
   }
 
   krewVersion = await installKrew(cachedPath, binary);
-
   core.setOutput("krew-version", krewVersion);
+
+  const installedPlugins = await installPlugins(cachedPath, binary, plugins);
+  core.setOutput("krew-plugins", JSON.stringify(installedPlugins));
 }
 
 function installKrew(cachedPath: string, binary: string): Promise<string> {
@@ -53,3 +55,41 @@ function installKrew(cachedPath: string, binary: string): Promise<string> {
     });
   });
 }
+
+async function installPlugins(
+  cachedPath: string,
+  binary: string,
+  plugins: string[]
+): Promise<Record<string, string>[]> {
+  const krewBin = `${homedir()}/.krew/bin`;
+  // parallel installs will not work, so we do have to await within the loop
+  const installed: Record<string, string>[] = [];
+  for (const plugin of plugins) {
+    installed.push(await installPlugin(krewBin, plugin));
+  }
+  return installed;
+}
+
+function installPlugin(
+  krewBin: string,
+  plugin: string
+): Promise<Record<string, string>> {
+  return new Promise((resolve, reject) => {
+    core.info(`Attempting to install plugin: ${plugin}…`);
+    exec(`${krewBin}/kubectl-krew install ${plugin}`, (e) => {
+      if (e) {
+        return reject(e);
+      }
+
+      const pluginBin = `kubectl-${plugin.replace("-", "_")}`;
+      exec(`${krewBin}/${pluginBin} version`, (e, stdout) => {
+        if (e) {
+          resolve({ [plugin]: "unknown" });
+        }
+
+        core.debug(stdout);
+        resolve({ [plugin]: stdout });
+      });
+    });
+  });
+}

lib/setup-kubectl.ts

@@ -10,6 +10,7 @@ import { setupKrew } from "./krew";
 export async function setupKubectl() {
   try {
     const kubectlVersion = await getVersion(core.getInput("kubectlVersion"));
+    const krewPlugins = getPlugins(core.getInput("plugins"));
 
     core.debug(`Installing kubectl ${kubectlVersion}…`);
 
@@ -44,15 +45,19 @@ export async function setupKubectl() {
     core.setOutput("kubectl-version", kubectlVersion);
 
     if (core.getInput("enablePlugins")) {
-      await setupKrew();
+      await setupKrew(krewPlugins);
     }
   } catch (e) {
     core.error(e as Error);
     throw e;
   }
 }
 
-async function getVersion(version: string) {
+function getPlugins(plugins: string): string[] {
+  return plugins.split(/,|\s/).filter((p) => p);
+}
+
+async function getVersion(version: string): Promise<string> {
   const semVerRegx =
     /^v(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/;
   switch (version) {