Reimplement shell scripts in node.js

charmed-kubernetes · Nov 6, 2024 · 437f0d8 · 437f0d8
1 parent 119d3fa
commit 437f0d8
Show file tree

Hide file tree

Showing 25 changed files with 166,244 additions and 1,280 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,4 @@
+lib/
+dist/
+node_modules/
+coverage/
diff --git a/.github/actions/with-post-steps/action.yaml b/.github/actions/with-post-steps/action.yaml
diff --git a/.github/actions/with-post-steps/main.js b/.github/actions/with-post-steps/main.js
diff --git a/.node-version b/.node-version
@@ -0,0 +1 @@
+22.11.0
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+dist/
+node_modules/
+coverage/
+**/*.yaml
+**/*.md
+**/*.yml
+**/*.json
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,17 @@
+{
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": true,
+    "quoteProps": "as-needed",
+    "jsxSingleQuote": false,
+    "trailingComma": "none",
+    "bracketSpacing": true,
+    "bracketSameLine": true,
+    "arrowParens": "avoid",
+    "proseWrap": "always",
+    "htmlWhitespaceSensitivity": "css",
+    "endOfLine": "lf"
+  }
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 This GitHub Action is open source ([Apache License 2.0](./LICENSE)) and we
 actively seek any community contributions for code, suggestions and
-documentation.  This page details a few notes, workflows and suggestions for
+documentation. This page details a few notes, workflows and suggestions for
 how to make contributions most effective and help us all build a better workflow -
 please give them a read before working on any contributions.
 
@@ -12,8 +12,8 @@ This action has been created under the [Apache License 2.0](./LICENSE), which
 will cover any contributions you may make to this project. Please familiarise
 yourself with the terms of the license.
 
-Additionally, this charm uses the Harmony CLA agreement.  It’s the easiest way
-for you to give us permission to use your contributions.  In effect, you’re
+Additionally, this charm uses the Harmony CLA agreement. It’s the easiest way
+for you to give us permission to use your contributions. In effect, you’re
 giving us a license, but you still own the copyright — so you retain the right
 to modify your code and use it in other projects. Please [sign the CLA
 here](https://ubuntu.com/legal/contributors/agreement) before making any

diff --git a/README.md b/README.md
@@ -13,9 +13,9 @@ Simply include the action as a step in your Workflow:
 
 This will give your job an environment with the following:
 
-  * Tox installed
-  * Juju installed
-  * A LXD (default) controller bootstrapped
+- Tox installed
+- Juju installed
+- A LXD (default) controller bootstrapped
 
 In addition to LXD, the action also supports Microk8s out-of-the-box. You can
 also use any other provider by passing in a `credentials.yaml` file (for public
@@ -56,21 +56,24 @@ jobs:
           clouds-yaml: ${{ secrets.CLOUDS_YAML }}
           bootstrap-options: "--model-default datastore=my-datastore"
 ```
+
 ## microk8s provider
+
 Using the microk8s provider some default add-ons will be enabled - specifically
 dns, storage and rbac. You can override these defaults with the following:
 
 ```yaml
-  add-on-test:
-    runs-on: ubuntu-latest
-    name: Testing custom addons
-    steps:
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          provider: microk8s
-          microk8s-addons: "storage dns rbac registry"
+add-on-test:
+  runs-on: ubuntu-latest
+  name: Testing custom addons
+  steps:
+    - name: Setup operator environment
+      uses: charmed-kubernetes/actions-operator@main
+      with:
+        provider: microk8s
+        microk8s-addons: "storage dns rbac registry"
 ```
+
 Currently, if specific addons are defined, a minimum set of addons (the defaults) `dns, storage, rbac` must be enabled for the action to work properly..
 
 ## pytest-operator
@@ -80,6 +83,7 @@ manage models, interacting with juju, charm building, bundle parameterization,
 and other features for testing Operator Charms.
 
 ## Multiple controllers
+
 You can bootstrap multiple controllers. Each controller will be named after
 the provider used to bootstrap it (e.g. `github-pr-ad8d9-microk8s`). This means
 that you can currently bootstrap only one controller of each kind.
@@ -92,34 +96,34 @@ Note: there is a [known issue](https://bugs.launchpad.net/juju/+bug/2003582)
 deploying lxd next to microk8s on Juju 2.9 (this works with Juju 3).
 
 ```yaml
-  multi-controller-tests:
-    name: microk8s-and-lxd-test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Setup k8s controller
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: 3.0/stable
-          provider: microk8s
-          channel: 1.26-strict/stable
-      - name: Save k8s controller name
-        id: k8s-controller
-        # The `CONTROLLER_NAME` envvar is set by this actions
-        run: echo "name=$CONTROLLER_NAME" >> $GITHUB_OUTPUT
-      - name: Setup lxd controller
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: 3.0/stable
-          provider: lxd
-      - name: Save lxd controller name
-        id: lxd-controller
-        # The `CONTROLLER_NAME` envvar is set by this action
-        run: echo "name=$CONTROLLER_NAME" >> $GITHUB_OUTPUT
-      - name: Run integration tests
-        run: ...
-        env:
-          K8S_CONTROLLER: ${{ steps.k8s-controller.outputs.name }}
-          LXD_CONTROLLER: ${{ steps.lxd-controller.outputs.name }}
+multi-controller-tests:
+  name: microk8s-and-lxd-test
+  runs-on: ubuntu-latest
+  steps:
+    - name: Setup k8s controller
+      uses: charmed-kubernetes/actions-operator@main
+      with:
+        juju-channel: 3.0/stable
+        provider: microk8s
+        channel: 1.26-strict/stable
+    - name: Save k8s controller name
+      id: k8s-controller
+      # The `CONTROLLER_NAME` envvar is set by this actions
+      run: echo "name=$CONTROLLER_NAME" >> $GITHUB_OUTPUT
+    - name: Setup lxd controller
+      uses: charmed-kubernetes/actions-operator@main
+      with:
+        juju-channel: 3.0/stable
+        provider: lxd
+    - name: Save lxd controller name
+      id: lxd-controller
+      # The `CONTROLLER_NAME` envvar is set by this action
+      run: echo "name=$CONTROLLER_NAME" >> $GITHUB_OUTPUT
+    - name: Run integration tests
+      run: ...
+      env:
+        K8S_CONTROLLER: ${{ steps.k8s-controller.outputs.name }}
+        LXD_CONTROLLER: ${{ steps.lxd-controller.outputs.name }}
 ```
 
 [pytest-operator]: https://github.com/charmed-kubernetes/pytest-operator
diff --git a/action.yaml b/action.yaml
@@ -1,6 +1,6 @@
 name: "Setup Operator environment"
 description: "Setup a operator environment"
-author: "Adam Stokes"
+author: "Adam Dyess"
 inputs:
   concierge-channel:
     description: |
@@ -80,14 +80,10 @@ inputs:
   container-registry-url:
     description: "Container registry to use"
 runs:
-  using: "composite"
-  steps:
-    - name: Cache
-      uses: ./.github/actions/with-post-steps
-      with:
-        json: ${{ toJson(inputs) }}
-        main: "src/bootstrap/main.sh"
-        post: "src/cleanup/main.sh"
+  using: node20
+  main: ./dist/build/index.js
+  post: ./dist/cleanup/index.js
+
 branding:
-  icon: "play"
+  icon: "cloud"
   color: "blue"