nix fmt

Reviewed-on: Luis/consulting-website#5

.envrc

@@ -3,3 +3,5 @@ if ! has nix_direnv_version || ! nix_direnv_version 2.3.0; then
 fi
 
 use flake
+
+

.gitea/workflows/ui_assets.yaml

@@ -15,7 +15,7 @@ jobs:
         id: changed-files
         uses: tj-actions/changed-files@v32
         with:
-          fetch-depth: 2
+          fetch-depth: 0
 
       - name: Check if UI files are in the list of modified files
         run: |
@@ -35,8 +35,8 @@ jobs:
               export PATH=$PATH:$DEPS
 
               # Setup git config
-              git config --global user.email "ui-asset-bot@clan.lol"
-              git config --global user.name "ui-asset-bot"
+              git config --global user.email "$BOT_EMAIL"
+              git config --global user.name "$BOT_NAME"
 
               ################################################
               #                                              #
@@ -66,3 +66,5 @@ jobs:
         env:
           MODIFIED_FILES: ${{ steps.changed-files.outputs.modified_files }}
           GITEA_TOKEN: ${{ secrets.BOT_ACCESS_TOKEN }}
+          BOT_NAME: "ui-asset-bot"
+          BOT_EMAIL: "ui-asset-bot@gchq.icu"

README.md

@@ -1,9 +1,120 @@
-# clan.lol core
+# Website Template
 
-This is the monorepo of the clan.lol project
-In here are all the packages we use, all the nixosModules we use/expose, the CLI and tests for everything.
+This repository is a template to build high quality websites as a team.
+The frontend uses [React NextJS
+](https://nextjs.org/) and the backend uses Python with the [Fastapi framework](https://fastapi.tiangolo.com/). To ensure API compatibility between frontend and backend an `openapi.json` file is generated from the Python backend code, which defines the REST API. This `openapi.json` file is then fed into [Orval](https://orval.dev/), which generates Typescript bindings for the Rest API. To ensure code correctness, we use [mypy](https://mypy-lang.org/) to ensure the Python code is correctly statically typed, and [pytest](https://docs.pytest.org/en/7.4.x/) for backend tests. A Continuos Integration (CI) Bot, verifies the code with previously mentioned Quality Assurance (QA) tools and blocks Pull requests if any errors arise.
+For dependency management we use the [Nix package manager](https://nixos.org/) to ensure reproducibility.
 
-## cLAN config tool
+## Getting Started: Development Environment
 
-- The quickstart guide can be found here: [here](/clan/clan-core/src/branch/main/docs/quickstart.md)
-- Find the docs [here](/clan/clan-core/src/branch/main/docs/clan-config.md)
+1. Install the Nix package manager by [downloading the nix installer](https://github.com/DeterminateSystems/nix-installer/releases) or executing this command:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
+```
+
+2. Install direnv by [downloading the direnv package](https://direnv.net/docs/installation.html) or executing this command:
+
+```bash
+curl -sfL https://direnv.net/install.sh | bash
+```
+
+3. Clone the repository and cd into it
+4. You should see an error message reading like this:
+
+```bash
+direnv: error .envrc is blocked. Run `direnv allow` to approve its content
+```
+
+5. Execute `direnv allow` to allow automatically executing the shell script `.envrc` on entering the directory
+6. Go to `pkgs/clan-cli` and execute
+
+```bash
+direnv allow
+```
+
+Then wait for the backend to build  
+7. To start the backend server then execute:
+
+```
+clan webui --reload --no-open --log-level debug
+```
+
+The server will automatically restart if any Python file changes.  
+8. In a different shell go to `pkgs/ui` and execute
+
+```bash
+direnv allow
+```
+
+Then wait for the frontend to build.  
+9. To start the frontend, execute:
+
+```bash
+npm run dev
+```
+
+Visit the website by going to [http://localhost:3000](http://localhost:3000)
+
+## Getting started: Setup Git Workflow
+
+1. Register your Gitea account locally by executing
+
+```bash
+tea login add
+```
+
+You will then see a prompt, please fill it out like outlined below:
+
+```
+? URL of Gitea instance:  https://gitea.gchq.icu
+? Name of new Login [gitea.gchq.icu]:  gitea.gchq.icu:7171
+? Do you have an access token? No
+? Username:  MyUserName
+? Password:  **********
+? Set Optional settings: No
+```
+
+2. First add your changes to git:
+
+   1. `git add <file1> <file2>` your changes
+   2. Execute `nix fmt` to lint your files
+   3. `git commit -a -m "My descriptive commit message"`
+   4. Make sure your branch has the latest changes from upstream by executing:
+
+   ```bash
+   git fetch && git rebase origin/main --autostash
+   ```
+
+   5. Execute `git status` to see if you have a merge conflict.
+   6. If so edit the file and fix the conflict. Here is a tutorial how to do so in [vscode](https://code.visualstudio.com/docs/sourcecontrol/overview#_merge-conflicts)
+   7. Execute `git merge --continue` and repeat step 5 till there are no conflicts anymore
+
+3. To automatically open up a pull request, that gets merged if all tests pass execute:
+
+```bash
+merge-after-ci
+```
+
+4. Go to https://gitea.gchq.icu to the project page, and look under "Pull Requests" if there are any issues with it.
+5. If there are issues, fix them and redo step 2. Afterwards execute
+
+```
+git push origin HEAD:MyUserName-main
+```
+
+to directly push to your open pull request
+
+## Using this template
+
+Setup two new gitea accounts.
+One named `ui-asset-bot`, generate an access token for it with all access permissions and set under `settings/actions/secrets` a secret called `BOT_ACCESS_TOKEN` with the token.
+Also edit the file `.gitea/workflows/ui_assets.yaml` and change the `BOT_EMAIL` variable to the email you set for that account.
+The second account is called `merge-bot` edit the file `pkgs/merge-after-ci/default.nix`
+if the name should be different.
+Under Branches set the main branch to protected and add `merge-bot` to whitelisted users for pushing.
+Also set an unprotected file pattern to `**/ui-assets.nix`.
+Also set the option `Enable Status Check` to `build / test (pull_request)`
+Add `merge-bot` and `ui-asset-bot` as collaborators.
+Also set the option `Delete pull request branch after merge by default`
+Also the the default merge style to `Rebase then create merge commit`

pkgs/clan-cli/README.md

@@ -56,15 +56,15 @@ Add this `launch.json` to your .vscode directory to have working breakpoints in
 
 ## Run locally single-threaded for debugging
 
-By default tests run in parallel using pytest-parallel.
-pytest-parallel however breaks `breakpoint()`. To disable it, use this:
+By default tests run in parallel using pytest-xdist.
+pytest-xdist however breaks `breakpoint()`. To disable it, use this:
 
 ```console
-pytest --workers "" -s
+pytest -n0 -s
 ```
 
 You can also run a single test like this:
 
 ```console
-pytest --workers "" -s tests/test_secrets_cli.py::test_users
+pytest -n0 -s tests/test_secrets_cli.py::test_users
 ```

pkgs/clan-cli/tests/test_webui.py

@@ -9,6 +9,11 @@ import pytest
 from ports import PortFunction
 
 
+@pytest.mark.impure
+def test_nothing_much() -> None:
+    pass
+
+
 @pytest.mark.timeout(10)
 def test_start_server(unused_tcp_port: PortFunction, temporary_home: Path) -> None:
     port = unused_tcp_port()

pkgs/merge-after-ci/default.nix

@@ -21,6 +21,6 @@ writeShellApplication {
     remoteName="''${1:-origin}"
     targetBranch="''${2:-main}"
     shift && shift
-    tea-create-pr "$remoteName" "$targetBranch" --assignees consulting-bot "$@"
+    tea-create-pr "$remoteName" "$targetBranch" --assignees merge-bot "$@"
   '';
 }

pkgs/ui/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "search.exclude": {
+        "**/.direnv": true
+    }
+}

pkgs/ui/nix/ui-assets.nix

@@ -1,5 +1,5 @@
 { fetchzip }:
 fetchzip {
-  url = "https://git.clan.lol/api/packages/clan/generic/ui/1xk9if1sykv2kcv3zn0dxn7gd7hlqjbhzz6hrsw0yiksf03skg9r/assets.tar.gz";
-  sha256 = "1xk9if1sykv2kcv3zn0dxn7gd7hlqjbhzz6hrsw0yiksf03skg9r";
+  url = "https://gitea.gchq.icu/api/packages/ui-asset-bot/generic/ui/1inlxk1i9q87bw00zwqyvpm3m0hdgdffhxlymzgi5wvqn9syd0cm/assets.tar.gz";
+  sha256 = "1inlxk1i9q87bw00zwqyvpm3m0hdgdffhxlymzgi5wvqn9syd0cm";
 }

pkgs/ui/nix/update-ui-assets.sh

@@ -3,8 +3,17 @@ set -xeuo pipefail
 
 # GITEA_TOKEN
 if [[ -z "${GITEA_TOKEN:-}" ]]; then
-  echo "GITEA_TOKEN is not set"
-  echo "Go to https://gitea.gchq.icu/user/settings/applications and generate a token"
+  echo "GITEA_TOKEN is not set. Check if the secret BOT_ACCESS_TOKEN is set in the repository settings."
+  exit 1
+fi
+
+if [[ -z "${BOT_NAME:-}" ]]; then
+  echo "Env var BOT_NAME is not set. Use the name of the bot user here."
+  exit 1
+fi
+
+if [[ -z "${GITHUB_SERVER_URL:-}" ]]; then
+  echo "Env var GITHUB_SERVER_URL is not set. Please use the Gitea base URL here."
   exit 1
 fi
 
@@ -22,10 +31,12 @@ nix build '.#ui' --out-link "$tmpdir/result"
 tar --transform 's,^\.,assets,' -czvf "$tmpdir/assets.tar.gz" -C "$tmpdir"/result/lib/node_modules/*/out .
 NAR_HASH=$(nix-prefetch-url --unpack file://<(cat "$tmpdir/assets.tar.gz"))
 
-owner=Luis
-package_name=consulting-website
+owner=$BOT_NAME
+package_name=ui
 package_version=$NAR_HASH
-url="https://gitea.gchq.icu/api/packages/$owner/generic/$package_name/$package_version/assets.tar.gz"
+baseurl=$GITHUB_SERVER_URL
+
+url="$baseurl/api/packages/$owner/generic/$package_name/$package_version/assets.tar.gz"
 set +x
 curl --upload-file "$tmpdir/assets.tar.gz" -X PUT "$url?token=$GITEA_TOKEN"
 set -x