Add Github Action

Author: Dr-Electron

.github/actions/setup/action.yml

@@ -0,0 +1,77 @@
+name: 'iota-sandbox-setup'
+description: 'Setup IOTA Sandbox'
+inputs:
+  version:
+    description: 'Sandbox Version to use'
+    required: false
+    default: 'latest'
+  branch:
+    description: 'Branch/tag/commit to use'
+    required: false
+  protocol_parameters:
+    description: 'Path to custom protocol parameters file'
+    required: false
+  milestone_interval:
+    description: 'Custom milestone interval'
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: Check if a faucet profile is enabled
+      shell: bash
+      run: |
+        IFS=',' read -ra PROFILES <<< "${{ env.COMPOSE_PROFILES }}" # Split by ,
+        FAUCET_ENABLED=false
+        for i in "${PROFILES[@]}"; do
+          i=$(echo "$i" | xargs)  # Trim leading and trailing whitespaces
+          if [[ "$i" == "inx" || "$i" == "inx-faucet" ]]; then # Check if inx or inx-faucet profile is enabled
+            FAUCET_ENABLED=true
+            break
+          fi
+        done
+        echo "FAUCET_ENABLED=$FAUCET_ENABLED" >> "$GITHUB_ENV"
+    - name: Setup iota sandbox using release version
+      shell: bash
+      if: ${{ inputs.version && !inputs.branch }}
+      run: |
+        mkdir iota-sandbox
+        cd iota-sandbox
+        mkdir sandbox
+        cd sandbox
+        # Use the output of https://api.github.com/repos/iotaledger/iota-sandbox/releases/
+        if [[ "${{ inputs.version }}" == "latest" ]]; then
+          DOWNLOAD_URL=$(curl "https://api.github.com/repos/iotaledger/iota-sandbox/releases/latest" | jq -r '.assets[] | select(.name | contains("iota_sandbox")) | .browser_download_url')
+        else
+          DOWNLOAD_URL=$(curl "https://api.github.com/repos/iotaledger/iota-sandbox/releases/tags/${{ inputs.version }}" | jq -r '.assets[] | select(.name | contains("iota_sandbox")) | .browser_download_url')
+        fi
+        echo "Downloading sandbox from $DOWNLOAD_URL"
+        curl -L -o iota_sandbox.tar.gz $DOWNLOAD_URL
+        tar -xf iota_sandbox.tar.gz
+    - name: Setup iota sandbox using gitish version
+      shell: bash
+      if: ${{ inputs.branch }}
+      run: |
+        git clone https://github.com/iotaledger/iota-sandbox --branch ${{ inputs.branch }}
+    - name: Overwrite protocol parameters
+      shell: bash
+      if: ${{ inputs.protocol_parameters }}
+      run: |
+        cp -f ${{ inputs.protocol_parameters }} iota-sandbox/sandbox/protocol_parameters.json
+    - name: Change milestone interval
+      working-directory: iota-sandbox/sandbox
+      shell: bash
+      if: ${{ inputs.milestone_interval }}
+      run: |
+        yq eval '.services.inx-coordinator.command += "--coordinator.interval=${{ inputs.milestone_interval }}"' docker-compose.yml > tmp.yml && mv tmp.yml docker-compose.yml
+    - name: Bootstrap and start sandbox
+      working-directory: iota-sandbox/sandbox
+      shell: bash
+      run: |
+        sudo ./bootstrap.sh
+        docker compose up -d
+    - name: Wait for faucet to start
+      if: ${{ env.FAUCET_ENABLED == 'true' }}
+      shell: bash
+      run: wget -qO- https://raw.githubusercontent.com/iotaledger/wait-for/$WAIT_FOR_VERSION/wait-for | sh -s -- -t 60 http://localhost/faucet/api/info -- echo "Faucet is up"
+      env:
+        WAIT_FOR_VERSION: d48601a8a90c3d22fade68d09b4240739fb44a46 # v2.2.4

.github/actions/tear-down/action.yml

@@ -0,0 +1,12 @@
+name: 'iota-sandbox-tear-down'
+description: 'tear-down a iota sandbox'
+runs:
+  using: "composite"
+  steps:
+    - name: Tear down iota sandbox
+      shell: bash
+      run: |
+        cd iota-sandbox/sandbox
+        docker-compose down
+        cd ../..
+        sudo rm -rf iota-sandbox

README.md

@@ -56,7 +56,7 @@
       <a href="#about-the-project">About The Project</a>
     </li>
     <li><a href="#usage">Usage</a></li>
-    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#github-action">Github Action</a></li>
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
   </ol>
@@ -88,16 +88,42 @@ _For more examples, please refer to the [Documentation](https://example.com)_
 
 
 
-<!-- ROADMAP -->
-## Roadmap
+<!-- GITHUB ACTION -->
+## Github Action
 
-- [ ] Add Explorer
-- [x] Add Chronicle
-- [ ] Add Faucet
-    - [x] L1
-    - [ ] L2
+The IOTA Sandbox provides two actions to use the sandbox in CI/CD for testing. `setup` and `tear-down`.
 
-See the [open issues](https://github.com/iotaledger/iota-sandbox/issues) for a full list of proposed features (and known issues).
+### Usage
+
+You can add those actions to your workflow by simply using it in a step. You can specify a version of the sandbox or a commit-ish ref to use any commit, branch, or tag.
+
+```yml
+name: Sandbox
+
+on:
+  workflow-dispatch
+
+env:
+  # Specify which profiles you want to enable.
+  COMPOSE_PROFILES: 'inx-indexer, chronicle'
+
+jobs:
+  sandbox:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Start iota sandbox
+        uses: 'iotaledger/iota-sandbox/.github/actions/setup@VERION'
+        with:
+          # Optional. Specify an iota-sandbox version. Default is latest
+          version: 'v1.1.0'
+          # Optional. In case you want to use a commit-ish ref. If branch is set it will always overrule version
+          branch: branch-xy
+          # Optional. In case you want to use your own protocol parameters
+          protocol_parameters: ./.github/workflows/protocol_parameters.json
+
+      - name: Tear down iota sandbox
+        uses: 'iotaledger/iota-sandbox/.github/actions/setup@VERSION'
+```
 
 <p align="right">(<a href="#top">back to top</a>)</p>