Support Package Refresh 2024-10 (#15)

- Use describe command for collecting data
- Remove "get" data except for PV and PVCs
- Added list outputs for PV and PVCs (resolves #14 )
- Add an option to run a Test Pipeline before collecting data ( resolves  #13 )
- Refactored code to use TypeScript
- Refactored code to be in different files for separation of duty
- Updated dependency versions and Deno version

Author: ThatAmatoGuy

.devcontainer/devcontainer.json

@@ -1,14 +1,13 @@
 // For format details, see https://aka.ms/devcontainer.json.
 {
   "name": "Codefresh Support Package",
-  "image": "denoland/deno:1.46.3",
+  "image": "denoland/deno:2.0.3",
   "onCreateCommand": "apt-get update && apt-get install git zip -y",
   "customizations": {
     "vscode": {
       "settings": {
         "deno.enable": true,
-        "deno.lint": true,
-        "deno.unstable": false
+        "deno.lint": true
       },
       "extensions": [
         "denoland.vscode-deno",

CONTRIBUTIONS.md

@@ -20,8 +20,9 @@ Pull requests are the best way to propose changes to the codebase. We actively w
 
 ## Any contributions you make will be under the MIT Software License
 
-In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers
-the project. Feel free to contact the maintainers if that's a concern.
+In short, when you submit code changes, your submissions are understood to be under the same
+[MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if
+that's a concern.
 
 ## Development
 

README.md

@@ -76,3 +76,10 @@ chmod +x cf-support
 1. Go the the [Latest](https://github.com/codefresh-support/codefresh-support-package/releases/latest) release.
 1. Download the cf-support_windows_x86_64.zip file
 1. Run the `.exe` file via CMD or PowerShell
+
+## Exit Codes
+
+- 10 - Failed to get codefresh credentials. Please set the enviroment variables (CF_API_KEY and CF_BASE_URL) or make sure you have a valid codefresh config file.
+- 20 - Failed to Create Demo Pipeline / Project or Failed to run Demo Pipeline.
+- 30 - Failed to Delete Demo Pipeline / Project
+- 40 - Invalid Runtime Type. ex: Selecting On-Prem for a SaaS Account.

ci/codefresh.yaml

@@ -1,4 +1,4 @@
-version: "1.0"
+version: '1.0'
 
 stages:
   - Clone
@@ -20,7 +20,7 @@ steps:
     title: Compiling
     stage: Build
     arguments:
-      image: denoland/deno:alpine-1.46.3
+      image: denoland/deno:alpine-2.0.3
       commands:
         - cf_export VERSION=$(cat VERSION)
         - deno task compile

deno.json

@@ -1,23 +1,30 @@
 {
   "fmt": {
     "indentWidth": 2,
-    "lineWidth": 160,
+    "lineWidth": 120,
     "singleQuote": true,
     "semiColons": true,
-    "exclude": [".devcontainer/**"]
+    "exclude": [
+      ".devcontainer/**",
+      "README.md",
+      "ci/**"
+    ]
   },
   "tasks": {
     "pre-compile": "rm -rf ./bin && mkdir ./bin",
-    "compile:linux": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_linux_x86_64 --target=x86_64-unknown-linux-gnu ./src/main.js",
-    "compile:windows": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_windows_x86_64 --target=x86_64-pc-windows-msvc ./src/main.js",
-    "compile:apple": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_darwin_x86_64 --target=x86_64-apple-darwin ./src/main.js",
-    "compile:apple_arm64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_darwin_arm64 --target=aarch64-apple-darwin ./src/main.js",
+    "compile:linux": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_linux_x86_64 --target=x86_64-unknown-linux-gnu ./src/main.ts",
+    "compile:windows": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_windows_x86_64 --target=x86_64-pc-windows-msvc ./src/main.ts",
+    "compile:apple": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_darwin_x86_64 --target=x86_64-apple-darwin ./src/main.ts",
+    "compile:apple_arm64": "deno compile --config=./deno.json --allow-env --allow-read --allow-write --allow-net --unsafely-ignore-certificate-errors --allow-run --output=./bin/cf-support_darwin_arm64 --target=aarch64-apple-darwin ./src/main.ts",
     "compile": "deno task pre-compile && deno task compile:linux && deno task compile:windows && deno task compile:apple && deno task compile:apple_arm64"
   },
   "imports": {
-    "@cloudydeno/kubernetes-apis": "jsr:@cloudydeno/kubernetes-apis@^0.5.1",
+    "@cliffy/table": "jsr:@cliffy/table@1.0.0-rc.7",
+    "@cloudydeno/kubernetes-apis": "jsr:@cloudydeno/kubernetes-apis@^0.5.2",
     "@cloudydeno/kubernetes-client": "jsr:@cloudydeno/kubernetes-client@^0.7.3",
     "@fakoua/zip-ts": "jsr:@fakoua/zip-ts@^1.3.1",
-    "@std/yaml": "jsr:@std/yaml@^1.0.5"
+    "@std/encoding": "jsr:@std/encoding@^1.0.5",
+    "@std/yaml": "jsr:@std/yaml@^1.0.5",
+    "pako": "npm:pako@^2.1.0"
   }
-}
+}

src/codefresh.js

@@ -0,0 +1,52 @@
+import { parse } from '../deps.ts';
+
+enum ContextKeys {
+  Token = 'token',
+  Url = 'url',
+}
+
+interface Context {
+  [ContextKeys.Token]: string;
+  [ContextKeys.Url]: string;
+}
+
+interface CodefreshConfig {
+  contexts: {
+    [key: string]: Context;
+  };
+  'current-context': string;
+}
+
+async function readConfigFile() {
+  const configPath = Deno.build.os === 'windows'
+    ? `${Deno.env.get('USERPROFILE')}/.cfconfig`
+    : `${Deno.env.get('HOME')}/.cfconfig`;
+  const configFileContent = await Deno.readTextFile(configPath);
+  return parse(configFileContent) as CodefreshConfig;
+}
+
+async function getCodefreshCredentials(envVar: string, configKey: ContextKeys) {
+  const envValue = Deno.env.get(envVar);
+  if (envValue) {
+    return envValue;
+  }
+
+  try {
+    const cfConfig = await readConfigFile();
+    return cfConfig.contexts[cfConfig['current-context']][configKey];
+  } catch (error) {
+    console.error('Failed to get Codefresh credentials:', error);
+    console.error(
+      'Please set the environment variables (CF_API_KEY and CF_BASE_URL) or make sure you have a valid Codefresh config file.',
+    );
+    Deno.exit(10);
+  }
+}
+
+export async function autoDetectCodefreshClient() {
+  const headers = {
+    Authorization: await getCodefreshCredentials('CF_API_KEY', ContextKeys.Token),
+  };
+  const baseUrl = `${await getCodefreshCredentials('CF_BASE_URL', ContextKeys.Url)}/api`;
+  return { headers, baseUrl };
+}

src/codefresh/codefresh.ts

@@ -0,0 +1,13 @@
+import { fetchAndSaveData, prepareAndCleanup, RuntimeType, selectNamespace } from '../deps.ts';
+
+export async function gitopsRuntime() {
+  try {
+    const namespace = await selectNamespace();
+    console.log(`\nGathering data in "${namespace}" namespace for the GitOps Runtime.`);
+    await fetchAndSaveData(RuntimeType.gitops, namespace);
+    console.log('\nData Gathered Successfully.');
+    await prepareAndCleanup();
+  } catch (error) {
+    console.error(`Error gathering GitOps runtime data:`, error);
+  }
+}

src/codefresh/gitops.ts

@@ -0,0 +1,64 @@
+import { fetchAndSaveData, prepareAndCleanup, RuntimeType, selectNamespace, writeCodefreshFiles } from '../deps.ts';
+
+async function getAllAccounts(config: { headers: { Authorization: string }; baseUrl: string }) {
+  const response = await fetch(`${config.baseUrl}/admin/accounts`, {
+    method: 'GET',
+    headers: config.headers,
+  });
+  const accounts = await response.json();
+  await writeCodefreshFiles(accounts, 'onPrem-accounts');
+}
+
+async function getAllRuntimes(config: { headers: { Authorization: string }; baseUrl: string }) {
+  const response = await fetch(`${config.baseUrl}/admin/runtime-environments`, {
+    method: 'GET',
+    headers: config.headers,
+  });
+  const onPremRuntimes = await response.json();
+  await writeCodefreshFiles(onPremRuntimes, 'onPrem-runtimes');
+}
+
+async function getTotalUsers(config: { headers: { Authorization: string }; baseUrl: string }) {
+  const response = await fetch(`${config.baseUrl}/admin/user?limit=1&page=1`, {
+    method: 'GET',
+    headers: config.headers,
+  });
+  const users = await response.json();
+  await writeCodefreshFiles({ total: users.total }, 'onPrem-totalUsers');
+}
+
+async function getSystemFeatureFlags(config: { headers: { Authorization: string }; baseUrl: string }) {
+  const response = await fetch(`${config.baseUrl}/admin/features`, {
+    method: 'GET',
+    headers: config.headers,
+  });
+  const onPremSystemFF = await response.json();
+  await writeCodefreshFiles(onPremSystemFF, 'onPrem-systemFeatureFlags');
+}
+
+export async function onPrem(config: { headers: { Authorization: string }; baseUrl: string }) {
+  if (config.baseUrl === 'https://g.codefresh.io/api') {
+    console.error(
+      `\nCannot gather On-Prem data for Codefresh SaaS. Please select either ${RuntimeType.pipelines} or ${RuntimeType.gitops}.`,
+    );
+    console.error(
+      'If you need to gather data for Codefresh On-Prem, please update your ./cfconfig conext (or Envs) to point to an On-Prem instance.',
+    );
+    Deno.exit(40);
+  }
+  try {
+    const namespace = await selectNamespace();
+    console.log(`\nGathering data in "${namespace}" namespace for Codefresh On-Prem.`);
+    await fetchAndSaveData(RuntimeType.onprem, namespace);
+    await Promise.all([
+      getAllAccounts(config),
+      getAllRuntimes(config),
+      getTotalUsers(config),
+      getSystemFeatureFlags(config),
+    ]);
+    console.log('\nData Gathered Successfully.');
+    await prepareAndCleanup();
+  } catch (error) {
+    console.error(`Error gathering On-Prem data:`, error);
+  }
+}