Gitea x Laconicd + some doc updates (#549)

* combine instructions from 2 stacks


Former-commit-id: 77d194cfd9b0503c3e55e8c79429fa1f36a8d784

* tidy doc

---------

Co-authored-by: zramsay <zach@bluecollacoding.ca>

.gitea/workflows/gitea.yml

@@ -1,51 +0,0 @@
-name: Test Gitea
-
-on:
-  pull_request:
-    branches: '*'
-  push:
-    branches:
-      - main
-      - zach-test
-      - new-gitea-test
-
-# Needed until we can incorporate docker startup into the executor container
-env:
-  DOCKER_HOST: unix:///var/run/dind.sock
-
-jobs:
-  test:
-    name: "Run Gitea package registry test"
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Update'
-        run: apt-get update
-      - name: 'Setup jq'
-        run: apt-get install jq -y
-      - name: 'Check jq'
-        run: |
-          which jq
-          jq --version
-      - name: "Clone project repository"
-        uses: actions/checkout@v3
-      - name: "Install Python"
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.8'
-      - name: "Print Python version"
-        run: python3 --version
-      - name: "Install shiv"
-        run: pip install shiv
-      - name: "Generate build version file"
-        run: ./scripts/create_build_tag_file.sh
-      - name: "Build local shiv package"
-        run: ./scripts/build_shiv_package.sh
-      - name: Start dockerd # Also needed until we can incorporate into the executor
-        run: |
-          dockerd -H $DOCKER_HOST --userland-proxy=false &
-          sleep 5
-      - name: "Run gitea tests"
-        run: |
-          export CERC_SCRIPT_DEBUG=true &
-          ./tests/gitea/test.sh
-

.github/workflows/gitea.yml

@@ -1,29 +0,0 @@
-name: Gitea Test
-
-on:
-  pull_request:
-    branches: '*'
-  push:
-    branches: '*'
-
-jobs:
-  test:
-    name: "Run basic test suite"
-    runs-on: ubuntu-latest
-    steps:
-      - name: "Clone project repository"
-        uses: actions/checkout@v3
-      - name: "Install Python"
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.8'
-      - name: "Print Python version"
-        run: python3 --version
-      - name: "Install shiv"
-        run: pip install shiv
-      - name: "Generate build version file"
-        run: ./scripts/create_build_tag_file.sh
-      - name: "Build local shiv package"
-        run: ./scripts/build_shiv_package.sh
-      - name: "Run gitea tests"
-        run: ./tests/gitea/test.sh

app/build_npms.py

@@ -132,8 +132,8 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
             try:
                 docker.run(builder_js_image_name,
                            remove=True,
-                           interactive=False,
+                           interactive=True,
-                           tty=False,
+                           tty=True,
                            user=f"{os.getuid()}:{os.getgid()}",
                            envs=envs,
                            # TODO: detect this host name in npm_registry_url rather than hard-wiring it

app/data/container-build/cerc-builder-js/build-npm-package.sh

@@ -1,25 +1,9 @@
 #!/bin/bash
 # Usage: build-npm-package.sh <registry-url> <publish-with-this-version>
 # Note: supply the registry auth token in CERC_NPM_AUTH_TOKEN
-#
-
-
 if [[ -n "$CERC_SCRIPT_DEBUG" ]]; then
     set -x
 fi
-
-echo "GITEA ACTIONS 1 is: $GITEA_ACTIONS"
-echo "GITEA ACTIONS 2 is: ${GITEA_ACTIONS}"
-
-echo "token 1 is: $CERC_NPM_AUTH_TOKEN"
-echo "token 2 is: ${CERC_NPM_AUTH_TOKEN}"
-
-if [[ "$GITEA_ACTIONS" = "true" ]]; then
-	echo "WORKS"
-else
-	echo "WTF"
-fi
-
 if ! [[ $# -eq 1 || $# -eq 2 ]]; then
     echo "Illegal number of parameters" >&2
     exit 1
@@ -44,10 +28,8 @@ npm config set @lirewine:registry ${local_npm_registry_url}
 local_npm_registry_url_fixed=$( echo ${local_npm_registry_url} | sed -e 's/^http[s]\{0,1\}://')
 npm config set -- ${local_npm_registry_url_fixed}:_authToken ${CERC_NPM_AUTH_TOKEN}
 # First check if the version of this package we're trying to build already exists in the registry
-# but this line: "jq -r .data.dist.tarball" fails only in gitea, so skip this block
-if [[ "${GITEA_ACTIONS}" != "true" ]]; then
 package_exists=$( yarn info --json ${package_name}@${package_publish_version} 2>/dev/null | jq -r .data.dist.tarball )
-  if [[ ! -z "$package_exists" && "$package_exists" != "null" ]]; then
+if [[ ! -z "$package_exists" && "$package_exists" != "null" ]]; then
     echo "${package_publish_version} of ${package_name} already exists in the registry"
     if [[ ${CERC_FORCE_REBUILD} == "true" ]]; then
         # Attempt to unpublish the existing package
@@ -57,7 +39,6 @@ package_exists=$( yarn info --json ${package_name}@${package_publish_version} 2>
         echo "skipping build since target version already exists"
         exit 0
     fi
-  fi
 fi
 echo "Build and publish ${package_name} version ${package_publish_version}"
 yarn install

docs/README.md

@@ -0,0 +1,8 @@
+# Stack Orchestrator
+
+Here you will find information about the design of stack orchestrator, contributing to it, and deploying services/applications that combine two or more "stacks".
+
+Most "stacks" contain their own README which has plenty of information on deploying, but stacks can be combined in a variety of ways which are document here, for example:
+
+- [Gitea with Laconicd Fixturenet](./gitea-with-laconicd-fixturenet.md)
+- [Laconicd Registry with Console](./laconicd-with-console.md)

docs/cli.md

@@ -6,7 +6,7 @@ Sub-commands and flags
 
 Clone a single repository:
 ```
-$ laconic-so setup-repositories --include cerc-io/go-ethereum
+$ laconic-so setup-repositories --include github.com/cerc-io/go-ethereum
 ```
 Clone the repositories for a stack:
 ```

docs/gitea-with-laconicd-fixturenet.md

@@ -0,0 +1,80 @@
+# Gitea x NPMs X Laconicd
+
+Deploy a local Gitea server, publish NPM packages to it, then use those packages to build a Laconicd fixturenet. Demonstrates several components of the Laconic stack
+
+### Build and Deploy Gitea
+
+```bash
+laconic-so --stack build-support build-containers
+laconic-so --stack package-registry setup-repositories
+laconic-so --stack package-registry build-containers 
+laconic-so --stack package-registry deploy up
+```
+
+These commands can take awhile. Eventually, some instructions and a token will output. Set `CERC_NPM_AUTH_TOKEN`:
+
+```bash
+export CERC_NPM_AUTH_TOKEN=<your-token>
+```
+
+### Configure the hostname gitea.local
+
+How to do this depends on your operating system  but usually involves editing a `hosts` file. For example, on Linux add this line to the file `/etc/hosts` (needs sudo):
+
+```bash
+127.0.0.1       gitea.local
+```
+
+Test with:
+
+```bash
+ping gitea.local
+```
+
+```bash
+PING gitea.local (127.0.0.1) 56(84) bytes of data.
+64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.147 ms
+64 bytes from localhost (127.0.0.1): icmp_seq=2 ttl=64 time=0.033 ms
+```
+
+Although not necessary in order to build and publish packages, you can now access the Gitea web interface at: [http://gitea.local:3000](http://gitea.local:3000) using these credentials: `gitea_admin/admin1234` (Note: please properly secure Gitea if public internet access is allowed).
+
+### Build npm Packages
+
+Clone the required repositories:
+
+```bash
+laconic-so --stack fixturenet-laconicd setup-repositories
+```
+
+Build and publish the npm packages:
+
+```bash
+laconic-so --stack fixturenet-laconicd build-npms
+```
+
+Navigate to the Gitea console and switch to the `cerc-io` user then find the `Packages` tab to confirm that these two npm packages have been published:
+
+- `@cerc-io/laconic-registry-cli`
+- `@cerc-io/laconic-sdk`
+
+### Build and deploy fixturenet containers
+
+```bash
+laconic-so --stack fixturenet-laconicd build-containers
+laconic-so --stack fixturenet-laconicd deploy up
+```
+
+Check the logs:
+
+```bash
+laconic-so --stack fixturenet-laconicd deploy logs
+```
+
+### Test with the registry CLI
+
+```bash
+laconic-so --stack fixturenet-laconicd deploy exec cli "laconic cns status"
+```
+
+Try additional CLI commands, documented [here](https://github.com/cerc-io/laconic-registry-cli#operations).

docs/spec.md

@@ -1,7 +1,6 @@
 # Specification
 
-(note this page is out of date)
+Note: this page is out of date (but still useful) - it will no longer be useful once stacks are [decoupled from the tool functionality](https://github.com/cerc-io/stack-orchestrator/issues/315).
-
 
 ## Implementation
 

tests/gitea/test.sh

@@ -1,40 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-export CERC_SCRIPT_DEBUG=true
-if [ -n "$CERC_SCRIPT_DEBUG" ]; then
-  set -x
-fi
-# Dump environment variables for debugging
-echo "Environment variables:"
-env
-
-echo "holla 1 $GITEA_ACTIONS"
-echo "Running gitea test"
-
-# Bit of a hack, test the most recent package
-TEST_TARGET_SO=$( ls -t1 ./package/laconic-so* | head -1 )
-# Set a non-default repo dir
-export CERC_REPO_BASE_DIR=~/stack-orchestrator-gitea-test
-echo "Testing this package: $TEST_TARGET_SO"
-echo "Test version command"
-reported_version_string=$( $TEST_TARGET_SO version )
-echo "Version reported is: ${reported_version_string}"
-echo "Cloning repositories into: $CERC_REPO_BASE_DIR"
-rm -rf $CERC_REPO_BASE_DIR
-mkdir -p $CERC_REPO_BASE_DIR
-
-$TEST_TARGET_SO --stack build-support build-containers
-$TEST_TARGET_SO --stack package-registry setup-repositories
-$TEST_TARGET_SO --stack package-registry build-containers
-output=$($TEST_TARGET_SO --stack package-registry deploy-system up)
-token=$(echo $output | grep -o 'export CERC_NPM_AUTH_TOKEN=[^ ]*' | cut -d '=' -f 2)
-export CERC_NPM_AUTH_TOKEN=$token
-export GITEA_ACTIONS=true
-echo "holla 2 $GITEA_ACTIONS"
-$TEST_TARGET_SO --stack fixturenet-laconicd setup-repositories 
-$TEST_TARGET_SO --stack fixturenet-laconicd --verbose --debug build-npms --include laconic-sdk
-
-# Clean up
-$TEST_TARGET_SO --stack package-registry deploy-system down
-echo "Test passed"