├── .ct.yaml
├── .github
    ├── dependabot.yml
    └── workflows
    │   ├── build-images.yml
    │   ├── chart.yml
    │   ├── ci.yml
    │   └── release.yml
├── .gitignore
├── .rustfmt.toml
├── CONTRIBUTING.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── OWNERS
├── README.md
├── charts
    └── clowarden
    │   ├── .helmignore
    │   ├── Chart.yaml
    │   ├── LICENSE
    │   ├── README.md
    │   ├── charts
    │       └── postgresql-8.2.1.tgz
    │   ├── ci
    │       └── default-values.yaml
    │   ├── templates
    │       ├── _helpers.tpl
    │       ├── dbmigrator_job.yaml
    │       ├── dbmigrator_secret.yaml
    │       ├── server_deployment.yaml
    │       ├── server_ingress.yaml
    │       ├── server_secret.yaml
    │       ├── server_service.yaml
    │       └── server_serviceaccount.yaml
    │   └── values.yaml
├── clowarden-cli
    ├── Cargo.toml
    └── src
    │   └── main.rs
├── clowarden-core
    ├── Cargo.toml
    └── src
    │   ├── cfg.rs
    │   ├── directory
    │       ├── legacy.rs
    │       └── mod.rs
    │   ├── github.rs
    │   ├── lib.rs
    │   ├── multierror.rs
    │   └── services
    │       ├── github
    │           ├── legacy.rs
    │           ├── mod.rs
    │           ├── service.rs
    │           └── state.rs
    │       └── mod.rs
├── clowarden-server
    ├── Cargo.toml
    ├── Dockerfile
    ├── src
    │   ├── cfg.rs
    │   ├── db.rs
    │   ├── github.rs
    │   ├── handlers.rs
    │   ├── jobs.rs
    │   ├── main.rs
    │   └── tmpl.rs
    └── templates
    │   ├── reconciliation-completed.md
    │   ├── validation-failed.md
    │   └── validation-succeeded.md
├── database
    └── migrations
    │   ├── Dockerfile
    │   ├── functions
    │       ├── 001_load_functions.sql
    │       └── changes
    │       │   └── search_changes.sql
    │   ├── migrate.sh
    │   └── schema
    │       └── 001_initial.sql
├── docs
    ├── dev.md
    ├── logo
    │   └── logo.png
    └── screenshots
    │   ├── audit-tool.png
    │   ├── invalid-config-check-run.png
    │   ├── reconciliation-completed-success.png
    │   ├── valid-config-check-run.png
    │   ├── validation-error.png
    │   └── validation-succeeded.png
└── web
    ├── .prettierrc
    ├── eslint.config.js
    ├── package.json
    ├── public
        ├── index.html
        ├── manifest.json
        ├── root_index.html
        └── static
        │   └── media
        │       ├── clowarden.png
        │       ├── clowarden.svg
        │       ├── logo.png
        │       ├── logo192.png
        │       └── logo512.png
    ├── src
        ├── App.module.css
        ├── App.tsx
        ├── api
        │   └── index.ts
        ├── context
        │   └── AppContextProvider.tsx
        ├── data.tsx
        ├── index.tsx
        ├── layout
        │   ├── Layout.module.css
        │   ├── audit
        │   │   ├── Audit.module.css
        │   │   ├── SearchTipsModal.module.css
        │   │   ├── SearchTipsModal.tsx
        │   │   ├── Searchbar.module.css
        │   │   ├── Searchbar.tsx
        │   │   ├── filters
        │   │   │   ├── Filters.module.css
        │   │   │   ├── Filters.tsx
        │   │   │   ├── OrganizationsSelect.module.css
        │   │   │   ├── OrganizationsSelect.tsx
        │   │   │   ├── SelectedFilters.module.css
        │   │   │   ├── SelectedFilters.tsx
        │   │   │   └── TimeRange.tsx
        │   │   └── index.tsx
        │   ├── index.tsx
        │   ├── navigation
        │   │   ├── Footer.module.css
        │   │   ├── Footer.tsx
        │   │   ├── MobileSettings.module.css
        │   │   ├── MobileSettings.tsx
        │   │   ├── Navbar.module.css
        │   │   ├── Navbar.tsx
        │   │   ├── Settings.module.css
        │   │   ├── Settings.tsx
        │   │   ├── ThemeMode.module.css
        │   │   └── ThemeMode.tsx
        │   └── notFound
        │   │   ├── NotFound.module.css
        │   │   └── index.tsx
        ├── react-app-env.d.ts
        ├── setupTests.ts
        ├── types.ts
        └── utils
        │   ├── buildSearchParams.ts
        │   ├── calculateTimeRange.ts
        │   ├── localStoragePreferences.ts
        │   └── prepareQueryString.ts
    ├── tsconfig.json
    └── yarn.lock


/.ct.yaml:
--------------------------------------------------------------------------------
1 | helm-extra-args: --timeout 180s
2 | chart-repos:
3 |   - stable=https://charts.helm.sh/stable
4 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 |   - package-ecosystem: "npm"
 4 |     directory: "/web"
 5 |     schedule:
 6 |       interval: "weekly"
 7 |     groups:
 8 |       frontend:
 9 |         patterns:
10 |           - "*"
11 |         update-types:
12 |           - "minor"
13 |           - "patch"
14 | 
15 |   - package-ecosystem: "cargo"
16 |     directory: "/"
17 |     schedule:
18 |       interval: "weekly"
19 |     groups:
20 |       backend:
21 |         patterns:
22 |           - "*"
23 |         update-types:
24 |           - "minor"
25 |           - "patch"
26 | 
27 |   - package-ecosystem: "github-actions"
28 |     directory: "/"
29 |     schedule:
30 |       interval: "weekly"
31 |     groups:
32 |       github-actions:
33 |         patterns:
34 |           - "*"
35 | 
36 |   - package-ecosystem: "docker"
37 |     directory: "/clowarden-server"
38 |     schedule:
39 |       interval: "weekly"
40 |     ignore:
41 |       - dependency-name: "node"
42 |         versions: ["19-alpine3.19", "20-alpine3.19", "21-alpine3.19", "22-alpine3.19", "22-alpine3.20"]
43 | 
44 |   - package-ecosystem: "docker"
45 |     directory: "/database/migrations"
46 |     schedule:
47 |       interval: "weekly"
48 | 
49 | 


--------------------------------------------------------------------------------
/.github/workflows/build-images.yml:
--------------------------------------------------------------------------------
 1 | name: Build images
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 | 
 8 | jobs:
 9 |   build-clowarden-dbmigrator-image:
10 |     if: github.ref == 'refs/heads/main'
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout code
14 |         uses: actions/checkout@v4
15 |       - name: Configure AWS credentials
16 |         uses: aws-actions/configure-aws-credentials@v4
17 |         with:
18 |           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
19 |           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
20 |           aws-region: us-east-2
21 |       - name: Login to AWS ECR
22 |         id: login-ecr
23 |         uses: aws-actions/amazon-ecr-login@v2
24 |       - name: Build and push clowarden-dbmigrator image
25 |         env:
26 |           ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
27 |         run: |
28 |           docker build -f database/migrations/Dockerfile -t $ECR_REGISTRY/clowarden-dbmigrator:$GITHUB_SHA .
29 |           docker push $ECR_REGISTRY/clowarden-dbmigrator:$GITHUB_SHA
30 | 
31 |   build-clowarden-server-image:
32 |     if: github.ref == 'refs/heads/main'
33 |     runs-on: ubuntu-latest
34 |     steps:
35 |       - name: Checkout code
36 |         uses: actions/checkout@v4
37 |       - name: Configure AWS credentials
38 |         uses: aws-actions/configure-aws-credentials@v4
39 |         with:
40 |           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
41 |           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
42 |           aws-region: us-east-2
43 |       - name: Login to AWS ECR
44 |         id: login-ecr
45 |         uses: aws-actions/amazon-ecr-login@v2
46 |       - name: Build and push clowarden server image
47 |         env:
48 |           ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
49 |         run: |
50 |           docker build -f clowarden-server/Dockerfile -t $ECR_REGISTRY/clowarden-server:$GITHUB_SHA .
51 |           docker push $ECR_REGISTRY/clowarden-server:$GITHUB_SHA
52 | 


--------------------------------------------------------------------------------
/.github/workflows/chart.yml:
--------------------------------------------------------------------------------
 1 | name: Helm CI
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     paths:
 6 |       - "charts/**"
 7 | 
 8 | permissions: read-all
 9 | 
10 | jobs:
11 |   lint-and-test:
12 |     runs-on: ubuntu-latest
13 |     steps:
14 |       - name: Checkout code
15 |         uses: actions/checkout@v4
16 |         with:
17 |           fetch-depth: 0
18 |       - name: Set up Helm
19 |         uses: azure/setup-helm@v4
20 |         with:
21 |           version: v3.9.2
22 |       - name: Set up Python
23 |         uses: actions/setup-python@v5
24 |         with:
25 |           python-version: 3.7
26 |       - name: Set up chart-testing
27 |         uses: helm/chart-testing-action@v2.7.0
28 |       - name: Run chart-testing (list-changed)
29 |         id: list-changed
30 |         run: |
31 |           changed=$(ct --config .ct.yaml list-changed --target-branch ${{ github.event.repository.default_branch }})
32 |           if [[ -n "$changed" ]]; then
33 |             echo "changed=true" >> $GITHUB_OUTPUT
34 |           fi
35 |       - name: Run chart-testing (lint)
36 |         run: ct lint --config .ct.yaml --target-branch ${{ github.event.repository.default_branch }}
37 |       - name: Create kind cluster
38 |         uses: helm/kind-action@v1.12.0
39 |         if: steps.list-changed.outputs.changed == 'true'
40 |       - name: Run chart-testing (install)
41 |         run: ct install --config .ct.yaml --target-branch ${{ github.event.repository.default_branch }}
42 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | 
 3 | on:
 4 |   merge_group:
 5 |   pull_request:
 6 |     branches:
 7 |       - main
 8 | 
 9 | jobs:
10 |   linter-backend:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout code
14 |         uses: actions/checkout@v4
15 |       - name: Setup Rust
16 |         uses: dtolnay/rust-toolchain@master
17 |         with:
18 |           toolchain: 1.86.0
19 |           components: clippy, rustfmt
20 |       - name: Run clippy
21 |         run: cargo clippy --all-targets --all-features -- --deny warnings
22 |       - name: Run rustfmt
23 |         run: cargo fmt --all -- --check
24 | 
25 |   tests-backend:
26 |     runs-on: ubuntu-latest
27 |     steps:
28 |       - name: Checkout code
29 |         uses: actions/checkout@v4
30 |       - name: Setup Rust
31 |         uses: dtolnay/rust-toolchain@master
32 |         with:
33 |           toolchain: 1.86.0
34 |       - name: Run backend tests
35 |         run: cargo test
36 | 
37 |   tests-frontend:
38 |     runs-on: ubuntu-latest
39 |     env:
40 |       NODE_OPTIONS: --max_old_space_size=4096
41 |     steps:
42 |       - name: Checkout code
43 |         uses: actions/checkout@v4
44 |       - name: Cache node modules
45 |         uses: actions/cache@v4
46 |         with:
47 |           path: ./web/node_modules
48 |           key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
49 |           restore-keys: |
50 |             ${{ runner.os }}-yarn-
51 |       - name: Install dependencies
52 |         working-directory: ./web
53 |         run: yarn install --network-concurrency 1
54 |       - name: Run prettier
55 |         working-directory: ./web
56 |         run: yarn format:diff
57 |       - name: Run eslint
58 |         working-directory: ./web
59 |         run: yarn lint
60 |       - name: Run frontend tests
61 |         working-directory: ./web
62 |         run: yarn test --watchAll=false --passWithNoTests --verbose --maxWorkers=4
63 | 
64 | 


--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
 1 | name: Release
 2 | 
 3 | on:
 4 |   push:
 5 |     tags:
 6 |       - "v*"
 7 | 
 8 | permissions: read-all
 9 | 
10 | jobs:
11 |   build-and-publish-images:
12 |     runs-on: ubuntu-latest
13 |     steps:
14 |       - name: Set up QEMU
15 |         uses: docker/setup-qemu-action@v3
16 |       - name: Set up Docker Buildx
17 |         uses: docker/setup-buildx-action@v3
18 |       - name: Login to AWS Public ECR
19 |         uses: docker/login-action@v3
20 |         with:
21 |           registry: public.ecr.aws
22 |           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
23 |           password: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
24 |       - name: Extract tag name
25 |         id: extract_tag_name
26 |         run: echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
27 |       - name: Build and push clowarden-dbmigrator image
28 |         uses: docker/build-push-action@v6
29 |         with:
30 |           platforms: linux/amd64,linux/arm64
31 |           file: database/migrations/Dockerfile
32 |           tags: public.ecr.aws/g6m3a0y9/clowarden-dbmigrator:${{steps.extract_tag_name.outputs.tag}},public.ecr.aws/g6m3a0y9/clowarden-dbmigrator:latest
33 |           push: true
34 |       - name: Build and push clowarden-server image
35 |         uses: docker/build-push-action@v6
36 |         with:
37 |           platforms: linux/amd64,linux/arm64
38 |           file: clowarden-server/Dockerfile
39 |           tags: public.ecr.aws/g6m3a0y9/clowarden-server:${{steps.extract_tag_name.outputs.tag}},public.ecr.aws/g6m3a0y9/clowarden-server:latest
40 |           push: true
41 | 
42 |   package-and-publish-helm-chart:
43 |     needs:
44 |       - build-and-publish-images
45 |     permissions:
46 |       contents: write
47 |     runs-on: ubuntu-latest
48 |     steps:
49 |       - name: Checkout
50 |         uses: actions/checkout@v4
51 |         with:
52 |           fetch-depth: 0
53 |       - name: Configure Git
54 |         run: |
55 |           git config user.name "$GITHUB_ACTOR"
56 |           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
57 |       - name: Install Helm
58 |         uses: azure/setup-helm@v4
59 |       - name: Run chart-releaser
60 |         run: |
61 |           # From: https://github.com/metallb/metallb/blob/293f43c1f78ab1b5fa8879a76746b094bd9dd3ca/.github/workflows/publish.yaml#L134-L163
62 |           # Ref: https://github.com/helm/chart-releaser-action/issues/60
63 |           curl -sSLo cr.tar.gz "https://github.com/helm/chart-releaser/releases/download/v1.6.1/chart-releaser_1.6.1_linux_amd64.tar.gz"
64 |           tar -xzf cr.tar.gz
65 |           rm -f cr.tar.gz
66 |           repo=$(basename "$GITHUB_REPOSITORY")
67 |           owner=$(dirname "$GITHUB_REPOSITORY")
68 |           tag="${GITHUB_REF_NAME:1}"
69 |           exists=$(curl -s -H "Accept: application/vnd.github.v3+json" https://github.com/$GITHUB_REPOSITORY/releases/tag/$repo-chart-$tag -w %{http_code} -o /dev/null)
70 |           if [[ $exists != "200" ]]; then
71 |             echo "Creating release..."
72 |             # package chart
73 |             ./cr package charts/$repo
74 |             # upload chart to github releases
75 |             ./cr upload \
76 |                 --owner "$owner" \
77 |                 --git-repo "$repo" \
78 |                 --release-name-template "{{ .Name }}-chart-{{ .Version }}" \
79 |                 --token "${{ secrets.GITHUB_TOKEN }}"
80 |             # Update index and push to github pages
81 |             ./cr index \
82 |                 --owner "$owner" \
83 |                 --git-repo "$repo" \
84 |                 --index-path index.yaml \
85 |                 --release-name-template "{{ .Name }}-chart-{{ .Version }}" \
86 |                 --push
87 |           else
88 |             echo "Release already exists"
89 |           fi
90 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | /target
 2 | **/node_modules
 3 | web/build
 4 | web/build/audit
 5 | web/src/media
 6 | npm-debug.log*
 7 | yarn-debug.log*
 8 | yarn-error.log*
 9 | .DS_Store
10 | .vscode
11 | Chart.lock
12 | chart/charts
13 | 


--------------------------------------------------------------------------------
/.rustfmt.toml:
--------------------------------------------------------------------------------
1 | max_width = 110
2 | chain_width = 90
3 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing Guide
 2 | 
 3 | The CLOWarden project accepts contributions via [GitHub pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). This document outlines the process to help get your contribution accepted.
 4 | 
 5 | ## Issues and discussions
 6 | 
 7 | Feature requests, bug reports, and support requests all occur through GitHub issues and discussions. If you would like to file an issue, view existing issues, or comment on an issue please engage with issues at <https://github.com/cncf/clowarden/issues>. You can create new discussions, view existing ones and comment on them at <https://github.com/cncf/clowarden/discussions>.
 8 | 
 9 | ## Pull Requests
10 | 
11 | All changes to the source code and documentation are made through [GitHub pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). If you would like to make a change to the source, documentation, or other component in the repository please open a pull request with the change.
12 | 
13 | If you are unsure if the change will be welcome you may want to file an issue first. The issue can detail the change and you can get feedback from the maintainers prior to starting to make the change.
14 | 
15 | You can find the existing pull requests at <https://github.com/cncf/clowarden/pulls>.
16 | 
17 | ## Developer Certificate of Origin
18 | 
19 | The CLOWarden project uses a [Developers Certificate of Origin (DCO)](https://developercertificate.org/) to sign-off that you have the right to contribute the code being contributed. The full text of the DCO reads:
20 | 
21 | ```text
22 | Developer Certificate of Origin
23 | Version 1.1
24 | 
25 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
26 | 1 Letterman Drive
27 | Suite D4700
28 | San Francisco, CA, 94129
29 | 
30 | Everyone is permitted to copy and distribute verbatim copies of this
31 | license document, but changing it is not allowed.
32 | 
33 | 
34 | Developer's Certificate of Origin 1.1
35 | 
36 | By making a contribution to this project, I certify that:
37 | 
38 | (a) The contribution was created in whole or in part by me and I
39 |     have the right to submit it under the open source license
40 |     indicated in the file; or
41 | 
42 | (b) The contribution is based upon previous work that, to the best
43 |     of my knowledge, is covered under an appropriate open source
44 |     license and I have the right under that license to submit that
45 |     work with modifications, whether created in whole or in part
46 |     by me, under the same open source license (unless I am
47 |     permitted to submit under a different license), as indicated
48 |     in the file; or
49 | 
50 | (c) The contribution was provided directly to me by some other
51 |     person who certified (a), (b) or (c) and I have not modified
52 |     it.
53 | 
54 | (d) I understand and agree that this project and the contribution
55 |     are public and that a record of the contribution (including all
56 |     personal information I submit with it, including my sign-off) is
57 |     maintained indefinitely and may be redistributed consistent with
58 |     this project or the open source license(s) involved.
59 | ```
60 | 
61 | Every commit needs to have signoff added to it with a message like:
62 | 
63 | ```text
64 | Signed-off-by: Joe Smith <joe.smith@example.com>
65 | ```
66 | 
67 | Git makes doing this fairly straight forward. First, please use your real name (sorry, no pseudonyms or anonymous contributions).
68 | 
69 | If you set your `user.name` and `user.email` in your git configuration, you can sign your commit automatically with `git commit -s` or `git commit --signoff`.
70 | 
71 | Signed commits in the git log will look something like:
72 | 
73 | ```text
74 | Author: Joe Smith <joe.smith@example.com>
75 | Date:   Thu Feb 2 11:41:15 2018 -0800
76 | 
77 |     Update README
78 | 
79 |     Signed-off-by: Joe Smith <joe.smith@example.com>
80 | ```
81 | 
82 | Notice how the `Author` and `Signed-off-by` lines match. If they do not match the PR will be rejected by the automated DCO check.
83 | 
84 | If more than one person contributed to a commit than there can be more than one `Signed-off-by` line where each line is a signoff from a different person who contributed to the commit.
85 | 


--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [workspace]
 2 | resolver = "2"
 3 | members = [
 4 |     "clowarden-cli",
 5 |     "clowarden-core",
 6 |     "clowarden-server"
 7 | ]
 8 | 
 9 | [workspace.package]
10 | version = "0.2.0"
11 | license = "Apache-2.0"
12 | edition = "2021"
13 | rust-version = "1.86"
14 | 
15 | [workspace.dependencies]
16 | anyhow = "1.0.98"
17 | as-any = "0.3.2"
18 | askama = "0.14.0"
19 | async-trait = "0.1.88"
20 | axum = { version = "0.8.4", features = ["macros"] }
21 | base64 = "0.22.1"
22 | cached = { version = "0.55.1", features = ["async"] }
23 | clap = { version = "4.5.37", features = ["derive"] }
24 | clowarden-core = { path = "../clowarden-core" }
25 | deadpool-postgres = { version = "0.14.1", features = ["serde"] }
26 | figment = { version = "0.10.19", features = ["yaml", "env"] }
27 | futures = "0.3.31"
28 | hmac = "0.12.1"
29 | hex = "0.4.3"
30 | mime = "0.3.17"
31 | mockall = "0.13.1"
32 | octorust = { git = "https://github.com/tegioz/third-party-api-clients.git" }
33 | openssl = { version = "0.10.72", features = ["vendored"] }
34 | pem = "3.0.5"
35 | postgres-openssl = "0.5.1"
36 | regex = "1.11.1"
37 | serde = { version = "1.0.219", features = ["derive"] }
38 | serde_json = "1.0.140"
39 | serde_qs = "0.15.0"
40 | serde_yaml = "0.9.34"
41 | sha2 = "0.10.9"
42 | thiserror = "2.0.12"
43 | time = { version = "0.3.41", features = [
44 |     "formatting",
45 |     "macros",
46 |     "parsing",
47 |     "serde",
48 | ] }
49 | tokio = { version = "1.45.0", features = [
50 |     "macros",
51 |     "process",
52 |     "rt-multi-thread",
53 |     "signal",
54 |     "sync",
55 |     "time",
56 | ] }
57 | tokio-postgres = { version = "0.7.13", features = [
58 |     "with-uuid-1",
59 |     "with-serde_json-1",
60 |     "with-time-0_3",
61 | ] }
62 | tokio-util = { version = "0.7.15", features = ["rt"] }
63 | tower = "0.5.2"
64 | tower-http = { version = "0.6.3", features = ["auth", "fs", "set-header", "trace"] }
65 | tracing = "0.1.41"
66 | tracing-subscriber = { version = "0.3.19", features = ["env-filter", "json"] }
67 | uuid = { version = "1.16.0", features = ["serde", "v4"] }
68 | 


--------------------------------------------------------------------------------
/OWNERS:
--------------------------------------------------------------------------------
1 | maintainers:
2 | - tegioz
3 | - cynthia-sg
4 | 


--------------------------------------------------------------------------------
/charts/clowarden/.helmignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | .git/
3 | .gitignore
4 | *.swp
5 | .vscode/
6 | 


--------------------------------------------------------------------------------
/charts/clowarden/Chart.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v2
 2 | name: clowarden
 3 | description: CLOWarden is a tool that manages access to resources across multiple services
 4 | type: application
 5 | version: 0.2.0
 6 | appVersion: 0.2.0
 7 | kubeVersion: ">= 1.19.0-0"
 8 | home: https://clowarden.io
 9 | icon: https://raw.githubusercontent.com/cncf/clowarden/main/docs/logo/logo.png
10 | keywords:
11 |   - clowarden
12 | maintainers:
13 |   - name: Sergio
14 |     email: tegioz@icloud.com
15 |   - name: Cintia
16 |     email: cynthiasg@icloud.com
17 | dependencies:
18 |   - name: postgresql
19 |     version: 8.2.1
20 |     repository: https://charts.helm.sh/stable
21 |     condition: postgresql.enabled
22 | annotations:
23 |   artifacthub.io/category: skip-prediction
24 |   artifacthub.io/changes: |
25 |     - kind: added
26 |       description: Validate users detected in some kinds of changes
27 |     - kind: changed
28 |       description: Improve support for multiple organizations
29 |     - kind: changed
30 |       description: Migrate config to figment
31 |     - kind: changed
32 |       description: Some refactoring in jobs module
33 |     - kind: changed
34 |       description: Update documentation
35 |     - kind: changed
36 |       description: Bump Alpine to 3.21.0
37 |     - kind: changed
38 |       description: Bump Rust to 1.83
39 |     - kind: changed
40 |       description: Upgrade backend and frontend dependencies
41 |     - kind: fixed
42 |       description: Issue processing email invitations
43 |   artifacthub.io/images: |
44 |     - name: dbmigrator
45 |       image: public.ecr.aws/g6m3a0y9/clowarden-dbmigrator:v0.2.0
46 |     - name: server
47 |       image: public.ecr.aws/g6m3a0y9/clowarden-server:v0.2.0
48 |   artifacthub.io/links: |
49 |     - name: source
50 |       url: https://github.com/cncf/clowarden
51 |     - name: support
52 |       url: https://github.com/cncf/clowarden/issues
53 | 


--------------------------------------------------------------------------------
/charts/clowarden/README.md:
--------------------------------------------------------------------------------
  1 | # CLOWarden
  2 | 
  3 | [CLOWarden](https://clowarden.io) is a tool that manages access to resources across multiple services.
  4 | 
  5 | ## Introduction
  6 | 
  7 | This chart bootstraps a CLOWarden deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
  8 | 
  9 | ## Prerequisites
 10 | 
 11 | Before installing this chart, you need to [setup a GitHub application](https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/creating-a-github-app). The application requires the following permissions [to be set](https://docs.github.com/en/apps/maintaining-github-apps/editing-a-github-apps-permissions):
 12 | 
 13 | Repository:
 14 | 
 15 | - **Administration**: *read/write*
 16 | - **Checks**: *read/write*
 17 | - **Contents**: *read*
 18 | - **Metadata**: *read*
 19 | - **Pull requests**: *read/write*
 20 | 
 21 | Organization:
 22 | 
 23 | - **Administration**: *read/write*
 24 | - **Members**: *read/write*
 25 | 
 26 | In addition to those permissions, it must also be subscribed to the following events:
 27 | 
 28 | - *Pull Request*
 29 | 
 30 | CLOWarden expects GitHub events to be sent to the `/webhook/github` endpoint. In the GitHub application, please enable `webhook` and set the target URL to your exposed endpoint (ie: <https://your-clowarden-deployment/webhook/github>). You will need to define a random secret for the webhook (you can use the following command to do it: `openssl rand -hex 32`). Please note your webhook secret, as well as the GitHub application ID and private key, as you'll need them in the next step when installing the chart.
 31 | 
 32 | Once your GitHub application is ready you can install it in the organizations you need.
 33 | 
 34 | ## Installing the chart
 35 | 
 36 | Create a values file (`my-values.yaml`) that includes the configuration values required for your GitHub application:
 37 | 
 38 | ```yaml
 39 | server:
 40 |   githubApp:
 41 |     # GitHub application ID
 42 |     appId: 123456 # Replace with your GitHub app ID
 43 | 
 44 |     # GitHub application private key
 45 |     privateKey: |-
 46 |       -----BEGIN RSA PRIVATE KEY-----
 47 |       ...
 48 |       YOUR_APP_PRIVATE_KEY
 49 |       ...
 50 |       -----END RSA PRIVATE KEY-----
 51 | 
 52 |     # GitHub application webhook secret
 53 |     webhookSecret: "your-webhook-secret"
 54 | 
 55 |     # GitHub application webhook secret fallback (handy for webhook secret rotation)
 56 |     webhookSecretFallback: "old-webhook-secret"
 57 | ```
 58 | 
 59 | In addition to the GitHub application configuration, you can also add the organizations you'd like to use CLOWarden with at this point:
 60 | 
 61 | ```yaml
 62 | organizations:
 63 |   - # Name of the GitHub organization
 64 |     name: org-name
 65 | 
 66 |     # CLOWarden's GitHub application installation id
 67 |     installationId: 12345678
 68 | 
 69 |     # Repository where the configuration files are located
 70 |     repository: .clowarden
 71 | 
 72 |     # Branch to use in the configuration repository
 73 |     branch: main
 74 | 
 75 |     # Legacy mode configuration
 76 |     legacy:
 77 |       # Whether legacy mode is enabled or not (must be at the moment)
 78 |       enabled: true
 79 | 
 80 |       # Path of the Sheriff's permissions file
 81 |       sheriffPermissionsPath: config.yaml
 82 | ```
 83 | 
 84 | CLOWarden includes a CLI tool that can be handy when adding new organizations to your CLOWarden deployment. For more information please see the [repository's README file](https://github.com/cncf/clowarden?#cli-tool).
 85 | 
 86 | > [!WARNING]
 87 | > Please note that during the reconciliation process, in an attemtp to keep the actual state in sync with the desired state, CLOWarden **will remove** resources **that are not defined** in the configuration file (i.e. teams and permissions, but not repositories). Always make sure that the configuration file represents the actual state (or that you are OK with the changes that will be applied) before enabling the service. The `generate` subcommand of the CLI tool can be helpful to create an initial configuration file from the actual state, whereas the `diff` subcommand can be used to display the differences between the actual and desired state (i.e. what changes will be applied when the service is enabled based on the current configuration file).
 88 | 
 89 | To install the chart with the release name `my-clowarden` run:
 90 | 
 91 | ```bash
 92 | $ helm repo add clowarden https://cncf.github.io/clowarden/
 93 | $ helm install --values my-values.yaml my-clowarden clowarden/clowarden
 94 | ```
 95 | 
 96 | The command above deploys CLOWarden on the Kubernetes cluster using the default configuration values and the GitHub application configuration provided. Please see the [chart's default values file](https://github.com/cncf/clowarden/blob/main/charts/clowarden/values.yaml) for a list of all the configurable parameters of the chart and their default values.
 97 | 
 98 | ## Uninstalling the chart
 99 | 
100 | To uninstall the `my-clowarden` deployment run:
101 | 
102 | ```bash
103 | $ helm uninstall my-clowarden
104 | ```
105 | 
106 | This command removes all the Kubernetes components associated with the chart and deletes the release.
107 | 
108 | ## How CLOWarden works
109 | 
110 | For more information about how CLOWarden works from a user's perspective please see the [repository's README file](https://github.com/cncf/clowarden#readme).
111 | 


--------------------------------------------------------------------------------
/charts/clowarden/charts/postgresql-8.2.1.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/charts/clowarden/charts/postgresql-8.2.1.tgz


--------------------------------------------------------------------------------
/charts/clowarden/ci/default-values.yaml:
--------------------------------------------------------------------------------
 1 | imageTag: latest
 2 | server:
 3 |   githubApp:
 4 |     # Sample app ID for chart testing
 5 |     appId: 123456
 6 |     # Sample key for chart testing
 7 |     privateKey: |-
 8 |       -----BEGIN RSA PRIVATE KEY-----
 9 |       MIIEowIBAAKCAQEAyJqjmieZuxZV6Uxtdf0OlFZltcC1ywrlqMLDNNpN6MBjpRYX
10 |       iG6mUlTgoqDDDbb2usvPmKfdO7bynemJmsmlzS9Tk1PPJTaHTAST5avjYXqSpAMR
11 |       4xvPUt097LD35TjGH4ZH4jCOpYvgKqrrma51HDOsucqG52OFoO+J0ZeSwtb2++Jg
12 |       N53Yp9uiYcEB/aafpNIktmX0ZT7/doDwk9Fz3j86CV+ctnlsObXGmZEHt5OMqREb
13 |       FbleFkEckha1sjio9iGcZCFHXCHZ/+/EyLnxLM/LFri+BIqAuOuLD+l29JJM+KSJ
14 |       nOC2ZkSYZxzKP4CW+4Z/kW6a3wTZ5uGsT7VhFwIDAQABAoIBADAmxkxzYvhAZUDJ
15 |       wqCGrKA4mNNmvXxOUlAO5/Jg0EClJYXz5pQuEyhCDWWb9xXsrA6sa1k2OeligZwb
16 |       +Za4/l5hFMuRW3CQRSufEa0YdEzqshZCUmHURBCc4IdW9zoDRbM9dTW6+BKOn7E+
17 |       M61A7gVl9fjmvzj9b47w0IEJxAWWTOGOsGgpeTp8RDA0zqkSHZ/huSvLvc3raexF
18 |       h8G3fSqseXehgVHuVnRC4ROSPFMnvR3f2F2nyvuErGPSq9aQEpik5iDzQTEMEy4v
19 |       Rk/D+w+M6JJ4uzra4N9e4C1pUmKhaWiHZWZ+SDlYlHNzJKyvcAT8Gtf1MAuwGbrk
20 |       vMjF7RECgYEA7yfjqmNMu1CkFkXZdyspy7i5D9SHNnUmlezpjpdEgQhel6XAs0EJ
21 |       6JhcWlw4p24tyMPLb6VahS6hu+QhkBpW3VQ5MeTPAKMF8xRJyK/n0Z7Thoa//6w1
22 |       1iCrKuZ6snHW+WPkG9DJ6btX5CIBADIfId4i+OkW3qBZDx06Ix83ZL8CgYEA1ruj
23 |       78xglZ6Z6QYIZp2NoIvqU5/2o1oyGDUGvhdREEm8Ld5S+unH+KCxZHQZzko1zXAv
24 |       KM14HBwT9pV2/9nbTLghKm4+gGRNjJC0P6XkUemr385svyIGImnHNbMIvEbpzaJP
25 |       jm12lyqHdAFJax1oipKjVmvvQj5gMciOdqlo4akCgYBR1hqHwbcOGggsPvatWq3Q
26 |       soNRMW6bafcsMoexbX3ZkZ2c0vFf5Y+YchqYKRqR4Jf2LVm9+J1DGbPqcaQyhXDY
27 |       B+wScLONCjwM9BJThC4Vgv3q+M1Wlf1OKpun8Hpn+aCQcmgqRIXzX1IyFJi3Em+o
28 |       zTS2bDyRLdmL3Hp6bkIsTQKBgDChSh0ykeUQiBan0Rs8LyjexvCtV3PjJ1koGSDP
29 |       swIXUNCqeuxsKWd7LPFtAbMgR1MBRwzci4kCKts7OjnzIqEbSheL5Ae7r3xYARow
30 |       /aY3Xz9ORn56vBzrC7xzkVTiUmzJh27gB21wqkBxUik5/cT0NJ2L0CGWcr6ThwAE
31 |       mcYRAoGBAMiyvQumxuBx07ip/YXxrAL3mKcc+2uy5rYS/pDkD70WowshWu0tQhHS
32 |       wH5+2oCEXWCZeeI/dXsYbQd3nudkXp8zR+D2rEGeKAlsQsG6xYW3i+8XBD0OIS6y
33 |       zXhNWWxXj/VC4KEom5b/QTmnzXFQ+/TjV3Pd5gPhacH5j4dvtXj1
34 |       -----END RSA PRIVATE KEY-----
35 |     # Sample webhook secret for chart testing
36 |     webhookSecret: "sample-secret-for-chart-testing"
37 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/_helpers.tpl:
--------------------------------------------------------------------------------
 1 | {{/* vim: set filetype=mustache: */}}
 2 | {{/*
 3 | Expand the name of the chart.
 4 | */}}
 5 | {{- define "chart.name" -}}
 6 | {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 7 | {{- end -}}
 8 | 
 9 | {{/*
10 | Create a default fully qualified app name.
11 | We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
12 | If release name contains chart name it will be used as a full name.
13 | */}}
14 | {{- define "chart.fullname" -}}
15 | {{- if .Values.fullnameOverride -}}
16 | {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
17 | {{- else -}}
18 | {{- $name := default .Chart.Name .Values.nameOverride -}}
19 | {{- if contains $name .Release.Name -}}
20 | {{- .Release.Name | trunc 63 | trimSuffix "-" -}}
21 | {{- else -}}
22 | {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
23 | {{- end -}}
24 | {{- end -}}
25 | {{- end -}}
26 | 
27 | {{/*
28 | Create chart name and version as used by the chart label.
29 | */}}
30 | {{- define "chart.chart" -}}
31 | {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
32 | {{- end -}}
33 | 
34 | {{/*
35 | Common labels
36 | */}}
37 | {{- define "chart.labels" -}}
38 | helm.sh/chart: {{ include "chart.chart" . }}
39 | {{ include "chart.selectorLabels" . }}
40 | {{- if .Chart.AppVersion }}
41 | app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
42 | {{- end }}
43 | app.kubernetes.io/managed-by: {{ .Release.Service }}
44 | {{- end -}}
45 | 
46 | {{/*
47 | Selector labels
48 | */}}
49 | {{- define "chart.selectorLabels" -}}
50 | app.kubernetes.io/name: {{ include "chart.name" . }}
51 | app.kubernetes.io/instance: {{ .Release.Name }}
52 | {{- end -}}
53 | 
54 | {{/*
55 | Kubernetes version
56 | Built-in object .Capabilities.KubeVersion.Minor can provide non-number output
57 | For example on GKE it returns "15+" instead of "15"
58 | */}}
59 | {{- define "chart.KubernetesVersion" -}}
60 | {{- $minorVersion := .Capabilities.KubeVersion.Minor | regexFind "[0-9]+" -}}
61 | {{- printf "%s.%s" .Capabilities.KubeVersion.Major $minorVersion -}}
62 | {{- end -}}
63 | 
64 | {{/*
65 | Kubernetes resource name prefix
66 | Using the prefix allows deploying multiple instances of the Chart in a single Kubernetes namespace.
67 | If the dynamic resource name prefix is disabled, this template results in an empty string.
68 | As described in `chart.fullname`, the length limit for some resource names is 63.
69 | Therefore, we truncate the prefix to have a max-length of 44 to respect this limit considering the
70 | longest resource name ("dbmigrator-install" = 18 chars).
71 | */}}
72 | {{- define "chart.resourceNamePrefix" -}}
73 | {{- if .Values.dynamicResourceNamePrefixEnabled -}}
74 | {{- (include "chart.fullname" .) | trunc 43 | trimSuffix "-" | printf "%s-" -}}
75 | {{- end -}}
76 | {{- end -}}
77 | 
78 | {{/*
79 | Provide an init container to verify the database is accessible
80 | */}}
81 | {{- define "chart.checkDbIsReadyInitContainer" -}}
82 | name: check-db-ready
83 | image: {{ .Values.postgresql.image.repository }}:{{ .Values.postgresql.image.tag }}
84 | imagePullPolicy: {{ .Values.pullPolicy }}
85 | env:
86 |   - name: PGHOST
87 |     value: {{ default (printf "%s-postgresql.%s" .Release.Name .Release.Namespace) .Values.db.host }}
88 |   - name: PGPORT
89 |     value: "{{ .Values.db.port }}"
90 |   - name: PGUSER
91 |     value: "{{ .Values.db.user }}"
92 | command: ['sh', '-c', 'until pg_isready; do echo waiting for database; sleep 2; done;']
93 | {{- end -}}
94 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/dbmigrator_job.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: batch/v1
 2 | kind: Job
 3 | metadata:
 4 | {{- if .Release.IsInstall }}
 5 |   name: {{ include "chart.resourceNamePrefix" . }}dbmigrator-install
 6 | {{- else }}
 7 |   name: {{ include "chart.resourceNamePrefix" . }}dbmigrator-upgrade
 8 |   annotations:
 9 |     "helm.sh/hook": pre-upgrade
10 |     "helm.sh/hook-weight": "0"
11 |     "helm.sh/hook-delete-policy": before-hook-creation
12 | {{- end }}
13 | spec:
14 |   template:
15 |     spec:
16 |     {{- with .Values.imagePullSecrets }}
17 |       imagePullSecrets:
18 |         {{- toYaml . | nindent 8 }}
19 |     {{- end }}
20 |       restartPolicy: Never
21 |       initContainers:
22 |         - {{- include "chart.checkDbIsReadyInitContainer" . | nindent 10 }}
23 |       containers:
24 |         - name: dbmigrator
25 |           image: {{ .Values.dbmigrator.job.image.repository }}:{{ .Values.imageTag | default (printf "v%s" .Chart.AppVersion) }}
26 |           imagePullPolicy: {{ .Values.pullPolicy }}
27 |           env:
28 |             - name: TERN_CONF
29 |               value: {{ .Values.configDir }}/tern.conf
30 |           volumeMounts:
31 |             - name: dbmigrator-config
32 |               mountPath: {{ .Values.configDir }}
33 |               readOnly: true
34 |           command: ["./migrate.sh"]
35 |       volumes:
36 |         - name: dbmigrator-config
37 |           secret:
38 |             secretName: {{ include "chart.resourceNamePrefix" . }}dbmigrator-config
39 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/dbmigrator_secret.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: Secret
 3 | metadata:
 4 |   name: {{ include "chart.resourceNamePrefix" . }}dbmigrator-config
 5 | type: Opaque
 6 | stringData:
 7 |   tern.conf: |-
 8 |     [database]
 9 |     host = {{ default (printf "%s-postgresql.%s" .Release.Name .Release.Namespace) .Values.db.host }}
10 |     port = {{ .Values.db.port }}
11 |     database = {{ .Values.db.dbname }}
12 |     user = {{ .Values.db.user }}
13 |     password = {{ .Values.db.password }}
14 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/server_deployment.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: apps/v1
 2 | kind: Deployment
 3 | metadata:
 4 |   name: {{ include "chart.resourceNamePrefix" . }}server
 5 |   labels:
 6 |     app.kubernetes.io/component: server
 7 |     {{- include "chart.labels" . | nindent 4 }}
 8 | spec:
 9 |   replicas: {{ .Values.server.deploy.replicaCount }}
10 |   selector:
11 |     matchLabels:
12 |       app.kubernetes.io/component: server
13 |       {{- include "chart.selectorLabels" . | nindent 6 }}
14 |   template:
15 |     metadata:
16 |       labels:
17 |         app.kubernetes.io/component: server
18 |         {{- include "chart.selectorLabels" . | nindent 8 }}
19 |     spec:
20 |     {{- with .Values.imagePullSecrets }}
21 |       imagePullSecrets:
22 |         {{- toYaml . | nindent 8 }}
23 |     {{- end }}
24 |       {{- if .Release.IsInstall }}
25 |       serviceAccountName: {{ include "chart.resourceNamePrefix" . }}server
26 |       {{- end }}
27 |       initContainers:
28 |         - {{- include "chart.checkDbIsReadyInitContainer" . | nindent 10 }}
29 |         {{- if .Release.IsInstall }}
30 |         - name: check-dbmigrator-run
31 |           image: "bitnami/kubectl:{{ template "chart.KubernetesVersion" . }}"
32 |           imagePullPolicy: IfNotPresent
33 |           command: ['kubectl', 'wait', '--namespace={{ .Release.Namespace }}', '--for=condition=complete', 'job/{{ include "chart.resourceNamePrefix" . }}dbmigrator-install', '--timeout=60s']
34 |         {{- end }}
35 |       containers:
36 |         - name: server
37 |           image: {{ .Values.server.deploy.image.repository }}:{{ .Values.imageTag | default (printf "v%s" .Chart.AppVersion) }}
38 |           imagePullPolicy: {{ .Values.pullPolicy }}
39 |           volumeMounts:
40 |             - name: server-config
41 |               mountPath: {{ .Values.configDir | quote }}
42 |               readOnly: true
43 |           ports:
44 |             - name: http
45 |               containerPort: 9000
46 |               protocol: TCP
47 |           resources:
48 |             {{- toYaml .Values.server.deploy.resources | nindent 12 }}
49 |           command: ['clowarden-server', '-c', '{{ .Values.configDir }}/clowarden.yml']
50 |       volumes:
51 |         - name: server-config
52 |           secret:
53 |             secretName: {{ include "chart.resourceNamePrefix" . }}server-config
54 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/server_ingress.yaml:
--------------------------------------------------------------------------------
 1 | {{- if .Values.server.ingress.enabled -}}
 2 | apiVersion: networking.k8s.io/v1
 3 | kind: Ingress
 4 | metadata:
 5 |   name: {{ include "chart.resourceNamePrefix" . }}server
 6 |   labels:
 7 |     app.kubernetes.io/component: server
 8 |     {{- include "chart.labels" . | nindent 4 }}
 9 |   {{- with .Values.server.ingress.annotations }}
10 |   annotations:
11 |     {{- toYaml . | nindent 4 }}
12 |   {{- end }}
13 | spec:
14 |   defaultBackend:
15 |     service:
16 |       name: {{ include "chart.resourceNamePrefix" . }}server
17 |       port:
18 |         number: {{ .Values.server.service.port }}
19 |   {{- with .Values.server.ingress.rules }}
20 |   rules:
21 |     {{- toYaml . | nindent 4 }}
22 |   {{- end }}
23 |   {{- with .Values.server.ingress.tls }}
24 |   tls:
25 |     {{- toYaml . | nindent 4 }}
26 |   {{- end }}
27 | {{- end }}
28 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/server_secret.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: Secret
 3 | metadata:
 4 |   name: {{ include "chart.resourceNamePrefix" . }}server-config
 5 | type: Opaque
 6 | stringData:
 7 |   clowarden.yml: |-
 8 |     db:
 9 |       host: {{ default (printf "%s-postgresql.%s" .Release.Name .Release.Namespace) .Values.db.host }}
10 |       port: {{ .Values.db.port | atoi }}
11 |       dbname: {{ .Values.db.dbname }}
12 |       user: {{ .Values.db.user }}
13 |       password: {{ .Values.db.password }}
14 |     log:
15 |       format: {{ .Values.log.format }}
16 |     server:
17 |       addr: {{ .Values.server.addr }}
18 |       staticPath: {{ .Values.server.staticPath }}
19 |       basicAuth:
20 |         enabled: {{ .Values.server.basicAuth.enabled }}
21 |         username: {{ .Values.server.basicAuth.username }}
22 |         password: {{ .Values.server.basicAuth.password }}
23 |       githubApp:
24 |         appId: {{ .Values.server.githubApp.appId }}
25 |         privateKey: {{ .Values.server.githubApp.privateKey | quote }}
26 |         webhookSecret: {{ .Values.server.githubApp.webhookSecret | quote }}
27 |         {{- with .Values.server.githubApp.webhookSecretFallback }}
28 |         webhookSecretFallback: {{ . | quote }}
29 |         {{- end }}
30 |     services:
31 |       github:
32 |         enabled: {{ .Values.services.github.enabled }}
33 |     organizations: {{ toYaml .Values.organizations | nindent 6 }}
34 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/server_service.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: Service
 3 | metadata:
 4 |   name: {{ include "chart.resourceNamePrefix" . }}server
 5 |   labels:
 6 |     app.kubernetes.io/component: server
 7 |     {{- include "chart.labels" . | nindent 4 }}
 8 | spec:
 9 |   type: {{ .Values.server.service.type }}
10 |   ports:
11 |     - port: {{ .Values.server.service.port }}
12 |       targetPort: http
13 |       protocol: TCP
14 |       name: http
15 |   selector:
16 |     app.kubernetes.io/component: server
17 |     {{- include "chart.selectorLabels" . | nindent 4 }}
18 | 


--------------------------------------------------------------------------------
/charts/clowarden/templates/server_serviceaccount.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: ServiceAccount
 3 | metadata:
 4 |   name: {{ include "chart.resourceNamePrefix" . }}server
 5 | ---
 6 | apiVersion: rbac.authorization.k8s.io/v1
 7 | kind: Role
 8 | metadata:
 9 |   name: {{ include "chart.resourceNamePrefix" . }}job-reader
10 | rules:
11 |   - apiGroups: ["batch"]
12 |     resources: ["jobs"]
13 |     verbs: ["get", "list", "watch"]
14 | ---
15 | apiVersion: rbac.authorization.k8s.io/v1
16 | kind: RoleBinding
17 | metadata:
18 |   name: {{ include "chart.resourceNamePrefix" . }}server-job-reader
19 | subjects:
20 |   - kind: ServiceAccount
21 |     name: {{ include "chart.resourceNamePrefix" . }}server
22 | roleRef:
23 |   kind: Role
24 |   name: {{ include "chart.resourceNamePrefix" . }}job-reader
25 |   apiGroup: rbac.authorization.k8s.io
26 | 


--------------------------------------------------------------------------------
/charts/clowarden/values.yaml:
--------------------------------------------------------------------------------
  1 | # CLOWarden chart default configuration values
  2 | 
  3 | imagePullSecrets: []
  4 | imageTag: ""
  5 | nameOverride: ""
  6 | pullPolicy: IfNotPresent
  7 | 
  8 | # Enable dynamic resource name prefix
  9 | #
 10 | # Enabling the dynamic resource name prefix ensures that the resources are named dynamically based on the Helm
 11 | # installation's name. This allows multiple installations of this chart in a single Kubernetes namespace. The prefix
 12 | # can be defined by using the `fullnameOverride`.
 13 | dynamicResourceNamePrefixEnabled: false
 14 | 
 15 | # Overwrites the installation's fullname generation (used for the dynamic resource name prefix)
 16 | fullnameOverride: ""
 17 | 
 18 | # Directory path where the configuration files should be mounted
 19 | configDir: "/home/clowarden/.config/clowarden"
 20 | 
 21 | # Database configuration
 22 | db:
 23 |   host: ""
 24 |   port: "5432"
 25 |   dbname: clowarden
 26 |   user: postgres
 27 |   password: postgres
 28 | 
 29 | # Log configuration
 30 | log:
 31 |   # Output format [json|pretty]
 32 |   format: json
 33 | 
 34 | # Database migrator configuration
 35 | dbmigrator:
 36 |   job:
 37 |     image:
 38 |       # Database migrator image repository (without the tag)
 39 |       repository: public.ecr.aws/g6m3a0y9/clowarden-dbmigrator
 40 | 
 41 | # CLOWarden server configuration
 42 | server:
 43 |   # Address to listen on
 44 |   addr: 0.0.0.0:9000
 45 | 
 46 |   # Path with static assets
 47 |   staticPath: /home/clowarden/web/build
 48 | 
 49 |   # Basic auth configuration
 50 |   basicAuth:
 51 |     # Enable basic auth
 52 |     enabled: false
 53 |     # Basic auth username
 54 |     username: clowarden
 55 |     # Basic auth password
 56 |     password: changeme
 57 | 
 58 |   # GitHub application configuration
 59 |   githubApp:
 60 |     # GitHub application ID
 61 |     appId: null
 62 |     # GitHub application private key
 63 |     privateKey: null
 64 |     # GitHub application webhook secret
 65 |     webhookSecret: null
 66 |     # GitHub application webhook secret fallback (handy for webhook secret rotation)
 67 |     webhookSecretFallback: null
 68 | 
 69 |   # Ingress configuration
 70 |   ingress:
 71 |     enabled: true
 72 |     annotations:
 73 |       kubernetes.io/ingress.class: nginx
 74 |     rules: []
 75 |     tls: []
 76 | 
 77 |   # Service configuration
 78 |   service:
 79 |     type: NodePort
 80 |     port: 80
 81 | 
 82 |   # Deployment configuration
 83 |   deploy:
 84 |     replicaCount: 1  # Do not increase
 85 |     image:
 86 |       repository: public.ecr.aws/g6m3a0y9/clowarden-server
 87 |     resources: {}
 88 | 
 89 | # Services CLOWarden will manage
 90 | services:
 91 |   github:
 92 |     enabled: true
 93 | 
 94 | # Organizations managed by this CLOWarden instance
 95 | organizations:
 96 |   []
 97 |   # - # Name of the GitHub organization
 98 |   #   name: org-name
 99 |   #   # CLOWarden's GitHub application installation id
100 |   #   installationId: 12345678
101 |   #   # Repository where the configuration files are located
102 |   #   repository: .clowarden
103 |   #   # Branch to use in the configuration repository
104 |   #   branch: main
105 |   #   # Legacy mode configuration
106 |   #   legacy:
107 |   #     # Whether legacy mode is enabled or not (must be at the moment)
108 |   #     enabled: true
109 |   #     # Path of the Sheriff's permissions file
110 |   #     sheriffPermissionsPath: config.yaml
111 | 
112 | # PostgreSQL configuration
113 | postgresql:
114 |   enabled: true
115 |   image:
116 |     repository: artifacthub/postgres
117 |     tag: latest
118 |   persistence:
119 |     mountPath: /data
120 |   postgresqlUsername: postgres
121 |   postgresqlPassword: postgres
122 |   postgresqlDatabase: clowarden
123 |   postgresqlDataDir: /data/pgdata
124 | 


--------------------------------------------------------------------------------
/clowarden-cli/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "clowarden-cli"
 3 | description = "CLOWarden CLI"
 4 | version.workspace = true
 5 | license.workspace = true
 6 | edition.workspace = true
 7 | rust-version.workspace = true
 8 | 
 9 | [dependencies]
10 | anyhow = { workspace = true }
11 | clap = { workspace = true }
12 | clowarden-core = { path = "../clowarden-core" }
13 | serde = { workspace = true }
14 | serde_yaml = { workspace = true }
15 | tokio = { workspace = true }
16 | tracing = { workspace = true }
17 | tracing-subscriber = { workspace = true }
18 | 


--------------------------------------------------------------------------------
/clowarden-cli/src/main.rs:
--------------------------------------------------------------------------------
  1 | #![warn(clippy::all, clippy::pedantic)]
  2 | #![allow(clippy::doc_markdown, clippy::similar_names)]
  3 | 
  4 | use std::{env, fs::File, path::PathBuf, sync::Arc};
  5 | 
  6 | use anyhow::{format_err, Result};
  7 | use clap::{Args, Parser, Subcommand};
  8 | 
  9 | use clowarden_core::{
 10 |     cfg::Legacy,
 11 |     directory,
 12 |     github::{GHApi, Source},
 13 |     multierror,
 14 |     services::{
 15 |         self,
 16 |         github::{
 17 |             self,
 18 |             service::{Ctx, SvcApi},
 19 |             State,
 20 |         },
 21 |         Change,
 22 |     },
 23 | };
 24 | 
 25 | /// Environment variable containing Github token.
 26 | const GITHUB_TOKEN: &str = "GITHUB_TOKEN";
 27 | 
 28 | #[derive(Parser)]
 29 | #[command(
 30 |     version,
 31 |     about = "CLOWarden CLI tool
 32 | 
 33 | This tool uses the GitHub API, which requires authentication. Please make sure
 34 | you provide a GitHub token (with repo and read:org scopes) by setting the
 35 | GITHUB_TOKEN environment variable."
 36 | )]
 37 | struct Cli {
 38 |     #[command(subcommand)]
 39 |     command: Command,
 40 | }
 41 | 
 42 | #[derive(Subcommand)]
 43 | enum Command {
 44 |     /// Display changes between the actual state (as defined in the services)
 45 |     /// and the desired state (as defined in the configuration).
 46 |     Diff(BaseArgs),
 47 | 
 48 |     /// Generate configuration file from the actual state (experimental).
 49 |     Generate(GenerateArgs),
 50 | 
 51 |     /// Validate the configuration in the repository provided.
 52 |     Validate(BaseArgs),
 53 | }
 54 | 
 55 | #[derive(Args)]
 56 | struct BaseArgs {
 57 |     /// GitHub organization.
 58 |     #[arg(long)]
 59 |     org: String,
 60 | 
 61 |     /// Configuration repository.
 62 |     #[arg(long)]
 63 |     repo: String,
 64 | 
 65 |     /// Configuration repository branch.
 66 |     #[arg(long)]
 67 |     branch: String,
 68 | 
 69 |     /// Permissions file.
 70 |     #[arg(long, default_value = "config.yaml")]
 71 |     permissions_file: String,
 72 | 
 73 |     /// People file.
 74 |     #[arg(long)]
 75 |     people_file: Option<String>,
 76 | }
 77 | 
 78 | #[derive(Args)]
 79 | struct GenerateArgs {
 80 |     /// GitHub organization.
 81 |     #[arg(long)]
 82 |     org: String,
 83 | 
 84 |     /// Output file.
 85 |     #[arg(long)]
 86 |     output_file: PathBuf,
 87 | }
 88 | 
 89 | #[tokio::main]
 90 | async fn main() -> Result<()> {
 91 |     let cli = Cli::parse();
 92 | 
 93 |     // Setup logging
 94 |     if std::env::var_os("RUST_LOG").is_none() {
 95 |         std::env::set_var("RUST_LOG", "clowarden_cli=debug");
 96 |     }
 97 |     tracing_subscriber::fmt::init();
 98 | 
 99 |     // Check if required Github token is present in environment
100 |     let github_token = match env::var(GITHUB_TOKEN) {
101 |         Err(_) => return Err(format_err!("{} not found in environment", GITHUB_TOKEN)),
102 |         Ok(token) => token,
103 |     };
104 | 
105 |     // Run command
106 |     match cli.command {
107 |         Command::Diff(args) => diff(args, github_token).await?,
108 |         Command::Validate(args) => validate(args, github_token).await?,
109 |         Command::Generate(args) => generate(args, github_token).await?,
110 |     }
111 | 
112 |     Ok(())
113 | }
114 | 
115 | /// Get changes between the actual state (service) and desired state (config).
116 | async fn diff(args: BaseArgs, github_token: String) -> Result<()> {
117 |     // GitHub
118 | 
119 |     // Setup services
120 |     let (gh, svc) = setup_services(github_token);
121 |     let legacy = setup_legacy(&args);
122 |     let ctx = setup_context(&args.org);
123 |     let src = setup_source(&args);
124 | 
125 |     // Get changes from the actual state to the desired state
126 |     println!("Calculating diff between the actual state and the desired state...");
127 |     let actual_state = State::new_from_service(svc.clone(), &ctx).await?;
128 |     let desired_state = State::new_from_config(gh, svc, &legacy, &ctx, &src).await?;
129 |     let changes = actual_state.diff(&desired_state);
130 | 
131 |     // Display changes
132 |     println!("\n# GitHub");
133 |     println!("\n## Directory changes\n");
134 |     for change in changes.directory {
135 |         println!("{}", change.template_format()?);
136 |     }
137 |     println!("\n## Repositories changes\n");
138 |     for change in changes.repositories {
139 |         println!("{}", change.template_format()?);
140 |     }
141 |     println!();
142 | 
143 |     Ok(())
144 | }
145 | 
146 | /// Generate a configuration file from the actual state of the services.
147 | ///
148 | /// NOTE: at the moment the configuration generated uses the legacy format for
149 | /// backwards compatibility reasons.
150 | async fn generate(args: GenerateArgs, github_token: String) -> Result<()> {
151 |     #[derive(serde::Serialize)]
152 |     struct LegacyCfg {
153 |         teams: Vec<directory::legacy::sheriff::Team>,
154 |         repositories: Vec<github::state::Repository>,
155 |     }
156 | 
157 |     println!("Getting actual state from GitHub...");
158 |     let (_, svc) = setup_services(github_token);
159 |     let ctx = setup_context(&args.org);
160 |     let actual_state = github::State::new_from_service(svc.clone(), &ctx).await?;
161 | 
162 |     println!("Generating configuration file and writing it to the output file provided...");
163 |     let cfg = LegacyCfg {
164 |         teams: actual_state.directory.teams.into_iter().map(Into::into).collect(),
165 |         repositories: actual_state.repositories,
166 |     };
167 |     let file = File::create(&args.output_file)?;
168 |     serde_yaml::to_writer(file, &cfg)?;
169 | 
170 |     println!("done!");
171 |     Ok(())
172 | }
173 | 
174 | /// Validate configuration.
175 | async fn validate(args: BaseArgs, github_token: String) -> Result<()> {
176 |     // GitHub
177 | 
178 |     // Setup services
179 |     let (gh, svc) = setup_services(github_token);
180 |     let legacy = setup_legacy(&args);
181 |     let ctx = setup_context(&args.org);
182 |     let src = setup_source(&args);
183 | 
184 |     // Validate configuration and display results
185 |     println!("Validating configuration...");
186 |     match github::State::new_from_config(gh, svc, &legacy, &ctx, &src).await {
187 |         Ok(_) => println!("Configuration is valid!"),
188 |         Err(err) => {
189 |             println!("{}\n", multierror::format_error(&err)?);
190 |             return Err(format_err!("Invalid configuration"));
191 |         }
192 |     }
193 | 
194 |     Ok(())
195 | }
196 | 
197 | /// Helper function to setup some services from the arguments provided.
198 | fn setup_services(github_token: String) -> (Arc<GHApi>, Arc<SvcApi>) {
199 |     let gh = GHApi::new_with_token(github_token.clone());
200 |     let svc = services::github::service::SvcApi::new_with_token(github_token);
201 | 
202 |     (Arc::new(gh), Arc::new(svc))
203 | }
204 | 
205 | /// Helper function to create a legacy config instance from the arguments.
206 | fn setup_legacy(args: &BaseArgs) -> Legacy {
207 |     Legacy {
208 |         enabled: true,
209 |         sheriff_permissions_path: args.permissions_file.clone(),
210 |         cncf_people_path: args.people_file.clone(),
211 |     }
212 | }
213 | 
214 | /// Helper function to create a context instance for the organization provided.
215 | fn setup_context(org: &str) -> Ctx {
216 |     Ctx {
217 |         inst_id: None,
218 |         org: org.to_string(),
219 |     }
220 | }
221 | 
222 | /// Helper function to create a source instance from the arguments.
223 | fn setup_source(args: &BaseArgs) -> Source {
224 |     Source {
225 |         inst_id: None,
226 |         owner: args.org.clone(),
227 |         repo: args.repo.clone(),
228 |         ref_: args.branch.clone(),
229 |     }
230 | }
231 | 


--------------------------------------------------------------------------------
/clowarden-core/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "clowarden-core"
 3 | description = "CLOWarden core"
 4 | version.workspace = true
 5 | license.workspace = true
 6 | edition.workspace = true
 7 | rust-version.workspace = true
 8 | 
 9 | [dependencies]
10 | anyhow = { workspace = true }
11 | as-any = { workspace = true }
12 | async-trait = { workspace = true }
13 | base64 = { workspace = true }
14 | cached = { workspace = true }
15 | futures = { workspace = true }
16 | octorust = { workspace = true }
17 | pem = { workspace = true }
18 | regex = { workspace = true }
19 | serde = { workspace = true }
20 | serde_json = { workspace = true }
21 | serde_yaml = { workspace = true }
22 | time = { workspace = true }
23 | tokio = { workspace = true }
24 | tracing = { workspace = true }
25 | 
26 | [dev-dependencies]
27 | mockall = { workspace = true }
28 | 


--------------------------------------------------------------------------------
/clowarden-core/src/cfg.rs:
--------------------------------------------------------------------------------
 1 | //! This module defines some types that represent parts of the configuration.
 2 | 
 3 | use serde::{Deserialize, Serialize};
 4 | 
 5 | /// GitHub application configuration.
 6 | #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 7 | #[serde(rename_all(deserialize = "camelCase"))]
 8 | pub struct GitHubApp {
 9 |     pub app_id: i64,
10 |     pub private_key: String,
11 |     pub webhook_secret: String,
12 |     pub webhook_secret_fallback: Option<String>,
13 | }
14 | 
15 | /// Organization configuration.
16 | #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
17 | #[serde(rename_all(deserialize = "camelCase"))]
18 | pub struct Organization {
19 |     pub name: String,
20 |     pub installation_id: i64,
21 |     pub repository: String,
22 |     pub branch: String,
23 |     pub legacy: Legacy,
24 | }
25 | 
26 | /// Organization legacy configuration.
27 | #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28 | #[serde(rename_all(deserialize = "camelCase"))]
29 | pub struct Legacy {
30 |     pub enabled: bool,
31 |     pub sheriff_permissions_path: String,
32 |     pub cncf_people_path: Option<String>,
33 | }
34 | 
35 | /// Services configuration.
36 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
37 | pub struct Services {
38 |     pub github: Service,
39 | }
40 | 
41 | /// Service configuration.
42 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
43 | pub struct Service {
44 |     pub enabled: bool,
45 | }
46 | 


--------------------------------------------------------------------------------
/clowarden-core/src/directory/legacy.rs:
--------------------------------------------------------------------------------
  1 | //! This module defines the types used to represent the legacy configuration
  2 | //! format (Sheriff's and CNCF's users). The directory module relies on this
  3 | //! module to create new directory instances from the legacy configuration.
  4 | 
  5 | use std::sync::LazyLock;
  6 | 
  7 | use anyhow::Result;
  8 | use regex::Regex;
  9 | use serde::{Deserialize, Serialize};
 10 | 
 11 | use crate::{
 12 |     cfg::Legacy,
 13 |     github::{DynGH, Source},
 14 |     multierror::MultiError,
 15 | };
 16 | 
 17 | pub(crate) static VALID_TEAM_NAME: LazyLock<Regex> =
 18 |     LazyLock::new(|| Regex::new(r"^[a-z0-9\-]+$").expect("expr in VALID_TEAM_NAME to be valid"));
 19 | 
 20 | /// Legacy configuration.
 21 | #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 22 | pub(crate) struct Cfg {
 23 |     pub sheriff: sheriff::Cfg,
 24 |     pub cncf: Option<cncf::Cfg>,
 25 | }
 26 | 
 27 | impl Cfg {
 28 |     /// Get legacy configuration.
 29 |     pub(crate) async fn get(gh: DynGH, legacy: &Legacy, src: &Source) -> Result<Cfg> {
 30 |         let mut merr = MultiError::new(Some("invalid directory configuration".to_string()));
 31 | 
 32 |         // Get sheriff configuration
 33 |         let sheriff = match sheriff::Cfg::get(gh.clone(), src, &legacy.sheriff_permissions_path).await {
 34 |             Ok(cfg) => Some(cfg),
 35 |             Err(err) => {
 36 |                 merr.push(err);
 37 |                 None
 38 |             }
 39 |         };
 40 | 
 41 |         // Get CNCF people configuration
 42 |         let cncf = match cncf::Cfg::get(gh, src, legacy.cncf_people_path.as_deref()).await {
 43 |             Ok(cfg) => cfg,
 44 |             Err(err) => {
 45 |                 merr.push(err);
 46 |                 None
 47 |             }
 48 |         };
 49 | 
 50 |         if merr.contains_errors() {
 51 |             return Err(merr.into());
 52 |         }
 53 |         Ok(Cfg {
 54 |             sheriff: sheriff.expect("sheriff config must be present"),
 55 |             cncf,
 56 |         })
 57 |     }
 58 | }
 59 | 
 60 | pub mod sheriff {
 61 |     use super::VALID_TEAM_NAME;
 62 |     use crate::{
 63 |         directory::{TeamName, UserName},
 64 |         github::{DynGH, Source},
 65 |         multierror::MultiError,
 66 |     };
 67 |     use anyhow::{format_err, Context, Error, Result};
 68 |     use serde::{Deserialize, Serialize};
 69 | 
 70 |     /// Sheriff configuration.
 71 |     /// https://github.com/electron/sheriff#permissions-file
 72 |     #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 73 |     pub(crate) struct Cfg {
 74 |         pub teams: Vec<Team>,
 75 |     }
 76 | 
 77 |     impl Cfg {
 78 |         /// Get sheriff configuration.
 79 |         pub(crate) async fn get(gh: DynGH, src: &Source, path: &str) -> Result<Self> {
 80 |             // Fetch configuration file and parse it
 81 |             let content = gh.get_file_content(src, path).await.context("error getting permissions file")?;
 82 |             let mut cfg: Cfg = serde_yaml::from_str(&content)
 83 |                 .map_err(Error::new)
 84 |                 .context("error parsing permissions file")?;
 85 | 
 86 |             // Process and validate configuration
 87 |             cfg.process_composite_teams();
 88 |             cfg.remove_duplicates();
 89 |             cfg.validate()?;
 90 | 
 91 |             Ok(cfg)
 92 |         }
 93 | 
 94 |         /// Extend team's maintainers and members with the maintainers and
 95 |         /// members of the teams listed in the formation field.
 96 |         fn process_composite_teams(&mut self) {
 97 |             let teams_copy = self.teams.clone();
 98 | 
 99 |             for team in &mut self.teams {
100 |                 if let Some(formation) = &team.formation {
101 |                     for team_name in formation {
102 |                         if let Some(source_team) = teams_copy.iter().find(|t| &t.name == team_name) {
103 |                             // Maintainers
104 |                             if let Some(maintainers) = team.maintainers.as_mut() {
105 |                                 maintainers
106 |                                     .extend_from_slice(source_team.maintainers.as_ref().unwrap_or(&vec![]));
107 |                             } else {
108 |                                 team.maintainers.clone_from(&source_team.maintainers);
109 |                             }
110 | 
111 |                             // Members
112 |                             if let Some(members) = team.members.as_mut() {
113 |                                 members.extend_from_slice(source_team.members.as_ref().unwrap_or(&vec![]));
114 |                             } else {
115 |                                 team.members.clone_from(&source_team.members);
116 |                             }
117 |                         }
118 |                     }
119 |                 }
120 |             }
121 |         }
122 | 
123 |         /// Remove duplicates in teams' maintainers and members.
124 |         fn remove_duplicates(&mut self) {
125 |             for team in &mut self.teams {
126 |                 // Maintainers
127 |                 if let Some(maintainers) = team.maintainers.as_mut() {
128 |                     maintainers.sort();
129 |                     maintainers.dedup();
130 |                 }
131 | 
132 |                 // Members
133 |                 if let Some(members) = team.members.as_mut() {
134 |                     members.sort();
135 |                     members.dedup();
136 |                 }
137 |             }
138 |         }
139 | 
140 |         /// Validate configuration.
141 |         fn validate(&self) -> Result<()> {
142 |             let mut merr = MultiError::new(None);
143 | 
144 |             let mut teams_seen = vec![];
145 |             for (i, team) in self.teams.iter().enumerate() {
146 |                 // Define id to be used in subsequent error messages. When
147 |                 // available, it'll be the team name. Otherwise we'll use its
148 |                 // index on the list.
149 |                 let id = if team.name.is_empty() {
150 |                     format!("{i}")
151 |                 } else {
152 |                     team.name.clone()
153 |                 };
154 | 
155 |                 // Name must be provided
156 |                 if team.name.is_empty() {
157 |                     merr.push(format_err!("team[{id}: name must be provided"));
158 |                 }
159 | 
160 |                 // Name must be valid
161 |                 if !VALID_TEAM_NAME.is_match(&team.name) {
162 |                     merr.push(format_err!(
163 |                         "team[{id}]: name must be lowercase alphanumeric with dashes (team slug)"
164 |                     ));
165 |                 }
166 | 
167 |                 // No duplicate config per team
168 |                 if !team.name.is_empty() {
169 |                     if teams_seen.contains(&&team.name) {
170 |                         merr.push(format_err!(
171 |                             "team[{id}]: duplicate config for team {}",
172 |                             &team.name
173 |                         ));
174 |                         continue;
175 |                     }
176 |                     teams_seen.push(&team.name);
177 |                 }
178 | 
179 |                 // At least one maintainer required
180 |                 if team.maintainers.as_ref().unwrap_or(&vec![]).is_empty() {
181 |                     merr.push(format_err!("team[{id}]: must have at least one maintainer"));
182 |                 }
183 | 
184 |                 // Users should be either a maintainer or a member, but not both
185 |                 for maintainer in team.maintainers.as_ref().unwrap_or(&vec![]) {
186 |                     if team.members.as_ref().unwrap_or(&vec![]).contains(maintainer) {
187 |                         merr.push(format_err!(
188 |                             "team[{id}]: {maintainer} must be either a maintainer or a member, but not both"
189 |                         ));
190 |                     }
191 |                 }
192 |             }
193 | 
194 |             if merr.contains_errors() {
195 |                 return Err(merr.into());
196 |             }
197 |             Ok(())
198 |         }
199 |     }
200 | 
201 |     /// Team configuration.
202 |     #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
203 |     pub struct Team {
204 |         pub name: String,
205 | 
206 |         #[serde(skip_serializing_if = "Option::is_none")]
207 |         pub maintainers: Option<Vec<UserName>>,
208 | 
209 |         #[serde(skip_serializing_if = "Option::is_none")]
210 |         pub members: Option<Vec<UserName>>,
211 | 
212 |         #[serde(skip_serializing_if = "Option::is_none")]
213 |         pub formation: Option<Vec<TeamName>>,
214 |     }
215 | 
216 |     impl From<crate::directory::Team> for Team {
217 |         fn from(team: crate::directory::Team) -> Self {
218 |             Team {
219 |                 name: team.name,
220 |                 maintainers: Some(team.maintainers),
221 |                 members: Some(team.members),
222 |                 ..Default::default()
223 |             }
224 |         }
225 |     }
226 | }
227 | 
228 | pub(crate) mod cncf {
229 |     use crate::{
230 |         github::{DynGH, Source},
231 |         multierror::MultiError,
232 |     };
233 |     use anyhow::{format_err, Context, Error, Result};
234 |     use serde::{Deserialize, Serialize};
235 | 
236 |     /// CNCF people configuration.
237 |     /// https://github.com/cncf/people/tree/main#listing-format
238 |     #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
239 |     #[serde(transparent)]
240 |     pub(crate) struct Cfg {
241 |         pub people: Vec<User>,
242 |     }
243 | 
244 |     impl Cfg {
245 |         /// Get CNCF people configuration.
246 |         pub(crate) async fn get(gh: DynGH, src: &Source, path: Option<&str>) -> Result<Option<Self>> {
247 |             match path {
248 |                 Some(path) => {
249 |                     let content =
250 |                         gh.get_file_content(src, path).await.context("error getting cncf people file")?;
251 |                     let cfg: Cfg = serde_json::from_str(&content)
252 |                         .map_err(Error::new)
253 |                         .context("error parsing cncf people file")?;
254 |                     cfg.validate()?;
255 |                     Ok(Some(cfg))
256 |                 }
257 |                 None => Ok(None),
258 |             }
259 |         }
260 | 
261 |         /// Validate configuration.
262 |         fn validate(&self) -> Result<()> {
263 |             let mut merr = MultiError::new(None);
264 | 
265 |             for (i, user) in self.people.iter().enumerate() {
266 |                 // Name must be provided
267 |                 if user.name.is_empty() {
268 |                     merr.push(format_err!("user[{}]: name must be provided", i));
269 |                 }
270 |             }
271 | 
272 |             if merr.contains_errors() {
273 |                 return Err(merr.into());
274 |             }
275 |             Ok(())
276 |         }
277 |     }
278 | 
279 |     /// User profile.
280 |     #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
281 |     pub(crate) struct User {
282 |         pub name: String,
283 |         pub bio: Option<String>,
284 |         pub company: Option<String>,
285 |         pub pronouns: Option<String>,
286 |         pub location: Option<String>,
287 |         pub linkedin: Option<String>,
288 |         pub twitter: Option<String>,
289 |         pub github: Option<String>,
290 |         pub wechat: Option<String>,
291 |         pub website: Option<String>,
292 |         pub youtube: Option<String>,
293 |         pub languages: Option<Vec<String>>,
294 |         pub projects: Option<Vec<String>>,
295 |         pub category: Option<Vec<String>>,
296 |         pub email: Option<String>,
297 |         pub slack_id: Option<String>,
298 |         pub image: Option<String>,
299 |     }
300 | }
301 | 


--------------------------------------------------------------------------------
/clowarden-core/src/github.rs:
--------------------------------------------------------------------------------
  1 | //! This module defines an abstraction layer over the GitHub API.
  2 | 
  3 | use std::sync::Arc;
  4 | 
  5 | use anyhow::{format_err, Context, Result};
  6 | use async_trait::async_trait;
  7 | use base64::{engine::general_purpose::STANDARD as b64, Engine as _};
  8 | #[cfg(test)]
  9 | use mockall::automock;
 10 | use octorust::{
 11 |     auth::{Credentials, InstallationTokenGenerator, JWTCredentials},
 12 |     Client,
 13 | };
 14 | 
 15 | use crate::cfg::{GitHubApp, Organization};
 16 | 
 17 | /// Trait that defines some operations a GH implementation must support.
 18 | #[async_trait]
 19 | #[allow(clippy::ref_option_ref)]
 20 | #[cfg_attr(test, automock)]
 21 | pub trait GH {
 22 |     /// Get file content.
 23 |     async fn get_file_content(&self, src: &Source, path: &str) -> Result<String>;
 24 | }
 25 | 
 26 | /// Type alias to represent a GH trait object.
 27 | pub type DynGH = Arc<dyn GH + Send + Sync>;
 28 | 
 29 | /// GH implementation backed by the GitHub API.
 30 | #[derive(Default)]
 31 | pub struct GHApi {
 32 |     app_credentials: Option<JWTCredentials>,
 33 |     token: Option<String>,
 34 | }
 35 | 
 36 | impl GHApi {
 37 |     /// Create a new GHApi instance using the token provided.
 38 |     #[must_use]
 39 |     pub fn new_with_token(token: String) -> Self {
 40 |         Self {
 41 |             token: Some(token),
 42 |             ..Default::default()
 43 |         }
 44 |     }
 45 | 
 46 |     /// Create a new GHApi instance using the app credentials provided in the
 47 |     /// configuration.
 48 |     pub fn new_with_app_creds(gh_app: &GitHubApp) -> Result<Self> {
 49 |         // Setup GitHub app credentials
 50 |         let private_key = pem::parse(&gh_app.private_key)?.contents().to_owned();
 51 |         let jwt_credentials =
 52 |             JWTCredentials::new(gh_app.app_id, private_key).context("error setting up credentials")?;
 53 | 
 54 |         Ok(Self {
 55 |             app_credentials: Some(jwt_credentials),
 56 |             ..Default::default()
 57 |         })
 58 |     }
 59 | 
 60 |     /// Setup GitHub API client for the installation id provided (if any).
 61 |     fn setup_client(&self, inst_id: Option<i64>) -> Result<Client> {
 62 |         let user_agent = format!("{}/{}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
 63 | 
 64 |         let credentials = if let Some(inst_id) = inst_id {
 65 |             let Some(app_creds) = self.app_credentials.clone() else {
 66 |                 return Err(format_err!(
 67 |                     "error setting up github client: app credentials not provided"
 68 |                 ));
 69 |             };
 70 |             Credentials::InstallationToken(InstallationTokenGenerator::new(inst_id, app_creds))
 71 |         } else {
 72 |             let Some(token) = self.token.clone() else {
 73 |                 return Err(format_err!("error setting up github client: token not provided"));
 74 |             };
 75 |             Credentials::Token(token)
 76 |         };
 77 | 
 78 |         Ok(Client::new(user_agent, credentials)?)
 79 |     }
 80 | }
 81 | 
 82 | #[async_trait]
 83 | impl GH for GHApi {
 84 |     /// [GH::get_file_content]
 85 |     async fn get_file_content(&self, src: &Source, path: &str) -> Result<String> {
 86 |         let client = self.setup_client(src.inst_id)?;
 87 |         let mut content = client
 88 |             .repos()
 89 |             .get_content_file(&src.owner, &src.repo, path, &src.ref_)
 90 |             .await?
 91 |             .content
 92 |             .as_bytes()
 93 |             .to_owned();
 94 |         content.retain(|b| !b" \n\t\r\x0b\x0c".contains(b));
 95 |         let decoded_content = String::from_utf8(b64.decode(content)?)?;
 96 |         Ok(decoded_content)
 97 |     }
 98 | }
 99 | 
100 | /// Information about the origin of a file located in a GitHub repository.
101 | pub struct Source {
102 |     pub inst_id: Option<i64>,
103 |     pub owner: String,
104 |     pub repo: String,
105 |     pub ref_: String,
106 | }
107 | 
108 | impl From<&Organization> for Source {
109 |     fn from(org: &Organization) -> Self {
110 |         Source {
111 |             inst_id: Some(org.installation_id),
112 |             owner: org.name.clone(),
113 |             repo: org.repository.clone(),
114 |             ref_: org.branch.clone(),
115 |         }
116 |     }
117 | }
118 | 


--------------------------------------------------------------------------------
/clowarden-core/src/lib.rs:
--------------------------------------------------------------------------------
 1 | #![warn(clippy::all, clippy::pedantic)]
 2 | #![allow(
 3 |     clippy::doc_markdown,
 4 |     clippy::missing_errors_doc,
 5 |     clippy::missing_panics_doc,
 6 |     clippy::similar_names
 7 | )]
 8 | 
 9 | pub mod cfg;
10 | pub mod directory;
11 | pub mod github;
12 | pub mod multierror;
13 | pub mod services;
14 | 


--------------------------------------------------------------------------------
/clowarden-core/src/multierror.rs:
--------------------------------------------------------------------------------
 1 | //! This module defines an error type that can aggregate multiple errors.
 2 | 
 3 | use std::fmt::{self, Write};
 4 | 
 5 | use anyhow::{Error, Result};
 6 | 
 7 | /// MultiError represents an error that aggregates a collection of errors.
 8 | #[derive(Debug, Default)]
 9 | pub struct MultiError {
10 |     pub context: Option<String>,
11 |     errors: Vec<Error>,
12 | }
13 | 
14 | impl MultiError {
15 |     /// Create a new MultiError instance.
16 |     #[must_use]
17 |     pub fn new(context: Option<String>) -> Self {
18 |         Self {
19 |             context,
20 |             errors: vec![],
21 |         }
22 |     }
23 | 
24 |     /// Check if there is at least one error.
25 |     #[must_use]
26 |     pub fn contains_errors(&self) -> bool {
27 |         !self.errors.is_empty()
28 |     }
29 | 
30 |     /// Return all errors.
31 |     #[must_use]
32 |     pub fn errors(&self) -> Vec<&Error> {
33 |         self.errors.iter().collect()
34 |     }
35 | 
36 |     // Append error provided to the internal list of errors.
37 |     pub fn push(&mut self, err: Error) {
38 |         self.errors.push(err);
39 |     }
40 | }
41 | 
42 | impl From<Error> for MultiError {
43 |     fn from(err: Error) -> Self {
44 |         Self {
45 |             context: None,
46 |             errors: vec![err],
47 |         }
48 |     }
49 | }
50 | 
51 | impl fmt::Display for MultiError {
52 |     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
53 |         for err in &self.errors {
54 |             write!(f, "{err:#} ")?;
55 |         }
56 |         Ok(())
57 |     }
58 | }
59 | 
60 | impl std::error::Error for MultiError {}
61 | 
62 | /// Format the error provided recursively.
63 | #[allow(clippy::missing_errors_doc)]
64 | pub fn format_error(err: &Error) -> Result<String> {
65 |     fn format_error(err: &Error, depth: usize, s: &mut String) -> Result<()> {
66 |         if let Some(merr) = err.downcast_ref::<MultiError>() {
67 |             let mut next_depth = depth;
68 |             if let Some(context) = &merr.context {
69 |                 write!(s, "\n{}- {context}", "\t".repeat(depth))?;
70 |                 next_depth += 1;
71 |             }
72 |             for err in &merr.errors() {
73 |                 format_error(err, next_depth, s)?;
74 |             }
75 |         } else {
76 |             write!(s, "\n{}- {err}", "\t".repeat(depth))?;
77 |             if err.chain().skip(1).count() > 0 {
78 |                 let mut depth = depth;
79 |                 for cause in err.chain().skip(1) {
80 |                     depth += 1;
81 |                     write!(s, "\n{}- {cause}", "\t".repeat(depth))?;
82 |                 }
83 |             }
84 |         }
85 |         Ok(())
86 |     }
87 | 
88 |     let mut s = String::new();
89 |     format_error(err, 0, &mut s)?;
90 |     Ok(s)
91 | }
92 | 


--------------------------------------------------------------------------------
/clowarden-core/src/services/github/legacy.rs:
--------------------------------------------------------------------------------
 1 | //! This module defines the types used to represent the legacy configuration
 2 | //! format (Sheriff's). The state module relies on this module to create new
 3 | //! state instances from the legacy configuration.
 4 | 
 5 | pub(crate) mod sheriff {
 6 |     use anyhow::{format_err, Context, Error, Result};
 7 |     use serde::{Deserialize, Serialize};
 8 | 
 9 |     use crate::{
10 |         directory::legacy::VALID_TEAM_NAME,
11 |         github::{DynGH, Source},
12 |         multierror::MultiError,
13 |         services::github::state::Repository,
14 |     };
15 | 
16 |     /// Sheriff configuration.
17 |     /// https://github.com/electron/sheriff#permissions-file
18 |     #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
19 |     pub(crate) struct Cfg {
20 |         pub repositories: Vec<Repository>,
21 |     }
22 | 
23 |     impl Cfg {
24 |         /// Get sheriff configuration.
25 |         pub(crate) async fn get(gh: DynGH, src: &Source, path: &str) -> Result<Self> {
26 |             let content =
27 |                 gh.get_file_content(src, path).await.context("error getting sheriff permissions file")?;
28 |             let cfg: Cfg = serde_yaml::from_str(&content)
29 |                 .map_err(Error::new)
30 |                 .context("error parsing permissions file")?;
31 |             cfg.validate()?;
32 |             Ok(cfg)
33 |         }
34 | 
35 |         /// Validate configuration.
36 |         fn validate(&self) -> Result<()> {
37 |             let mut merr = MultiError::new(Some("invalid github service configuration".to_string()));
38 | 
39 |             let mut repos_seen = vec![];
40 |             for (i, repo) in self.repositories.iter().enumerate() {
41 |                 // Define id to be used in subsequent error messages. When
42 |                 // available, it'll be the repo name. Otherwise we'll use its
43 |                 // index on the list.
44 |                 let id = if repo.name.is_empty() {
45 |                     format!("{i}")
46 |                 } else {
47 |                     repo.name.clone()
48 |                 };
49 | 
50 |                 // Name must be provided
51 |                 if repo.name.is_empty() {
52 |                     merr.push(format_err!("repo[{id}]: name must be provided"));
53 |                 }
54 | 
55 |                 // No duplicate config per repo
56 |                 if !repo.name.is_empty() {
57 |                     if repos_seen.contains(&&repo.name) {
58 |                         merr.push(format_err!(
59 |                             "repo[{id}]: duplicate config for repo {}",
60 |                             &repo.name
61 |                         ));
62 |                         continue;
63 |                     }
64 |                     repos_seen.push(&repo.name);
65 |                 }
66 | 
67 |                 // Teams names must be valid
68 |                 if let Some(teams) = &repo.teams {
69 |                     for team_name in teams.keys() {
70 |                         if !VALID_TEAM_NAME.is_match(team_name) {
71 |                             merr.push(format_err!(
72 |                                 "repo[{id}]: team[{team_name}] name must be lowercase alphanumeric with dashes (team slug)",
73 |                             ));
74 |                         }
75 |                     }
76 |                 }
77 |             }
78 | 
79 |             if merr.contains_errors() {
80 |                 return Err(merr.into());
81 |             }
82 |             Ok(())
83 |         }
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/clowarden-core/src/services/github/mod.rs:
--------------------------------------------------------------------------------
  1 | //! This module contains the implementation of the GitHub service handler.
  2 | 
  3 | use std::collections::HashSet;
  4 | 
  5 | use anyhow::{format_err, Context, Result};
  6 | use as_any::Downcast;
  7 | use async_trait::async_trait;
  8 | use state::Changes;
  9 | use tracing::debug;
 10 | 
 11 | use crate::{
 12 |     cfg::Organization,
 13 |     directory::{DirectoryChange, UserName},
 14 |     github::{DynGH, Source},
 15 |     multierror::MultiError,
 16 |     services::ChangeApplied,
 17 | };
 18 | 
 19 | use super::{BaseRefConfigStatus, ChangesApplied, ChangesSummary, DynChange, ServiceHandler};
 20 | 
 21 | use self::{
 22 |     service::{Ctx, DynSvc},
 23 |     state::{RepositoryChange, RepositoryInvitationId, RepositoryName},
 24 | };
 25 | 
 26 | mod legacy;
 27 | pub mod service;
 28 | pub mod state;
 29 | pub use state::State;
 30 | 
 31 | /// GitHub's service name.
 32 | pub const SERVICE_NAME: &str = "github";
 33 | 
 34 | /// GitHub's service handler.
 35 | pub struct Handler {
 36 |     gh: DynGH,
 37 |     svc: DynSvc,
 38 | }
 39 | 
 40 | impl Handler {
 41 |     /// Create a new Handler instance.
 42 |     pub fn new(gh: DynGH, svc: DynSvc) -> Self {
 43 |         Self { gh, svc }
 44 |     }
 45 | 
 46 |     /// Helper function to get the invitation id for a given user in a
 47 |     /// repository (when available).
 48 |     async fn get_repository_invitation(
 49 |         &self,
 50 |         ctx: &Ctx,
 51 |         repo_name: &RepositoryName,
 52 |         user_name: &UserName,
 53 |     ) -> Result<Option<RepositoryInvitationId>> {
 54 |         let invitation_id =
 55 |             self.svc.list_repository_invitations(ctx, repo_name).await?.iter().find_map(|i| {
 56 |                 if i.invitee.is_some() && &i.invitee.as_ref().unwrap().login == user_name {
 57 |                     return Some(i.id);
 58 |                 }
 59 |                 None
 60 |             });
 61 |         Ok(invitation_id)
 62 |     }
 63 | 
 64 |     /// Validate users found in some of the changes provided.
 65 |     async fn validate_users(&self, ctx: &Ctx, changes: &Changes) -> Result<()> {
 66 |         let mut merr = MultiError::new(Some("invalid github service configuration".to_string()));
 67 | 
 68 |         // Collect users to validate from changes
 69 |         let mut users_to_validate = HashSet::new();
 70 |         for change in &changes.directory {
 71 |             if let DirectoryChange::TeamMemberAdded(_, user_name) = change {
 72 |                 users_to_validate.insert(user_name);
 73 |             }
 74 |         }
 75 |         for change in &changes.repositories {
 76 |             if let RepositoryChange::CollaboratorAdded(_, user_name, _) = change {
 77 |                 users_to_validate.insert(user_name);
 78 |             }
 79 |         }
 80 | 
 81 |         // Validate users collected
 82 |         for user_name in users_to_validate {
 83 |             match self.svc.get_user_login(ctx, user_name).await {
 84 |                 Ok(valid_user_name) => {
 85 |                     if user_name != &valid_user_name {
 86 |                         merr.push(format_err!(
 87 |                             "user[{user_name}]: invalid username, should be {valid_user_name}",
 88 |                         ));
 89 |                     }
 90 |                 }
 91 |                 Err(err) => {
 92 |                     merr.push(format_err!("user[{user_name}]: error validating username: {err}"));
 93 |                 }
 94 |             }
 95 |         }
 96 | 
 97 |         if merr.contains_errors() {
 98 |             return Err(merr.into());
 99 |         }
100 |         Ok(())
101 |     }
102 | }
103 | 
104 | #[async_trait]
105 | impl ServiceHandler for Handler {
106 |     /// [ServiceHandler::get_changes_summary]
107 |     async fn get_changes_summary(&self, org: &Organization, head_src: &Source) -> Result<ChangesSummary> {
108 |         let ctx = Ctx::from(org);
109 |         let base_src = Source::from(org);
110 |         let head_state =
111 |             State::new_from_config(self.gh.clone(), self.svc.clone(), &org.legacy, &ctx, head_src).await?;
112 |         let (changes, base_ref_config_status) =
113 |             match State::new_from_config(self.gh.clone(), self.svc.clone(), &org.legacy, &ctx, &base_src)
114 |                 .await
115 |             {
116 |                 Ok(base_state) => {
117 |                     let changes = base_state.diff(&head_state);
118 |                     self.validate_users(&ctx, &changes).await?;
119 |                     let repositories_changes = changes
120 |                         .repositories
121 |                         .into_iter()
122 |                         .map(|change| Box::new(change) as DynChange)
123 |                         .collect();
124 |                     (repositories_changes, BaseRefConfigStatus::Valid)
125 |                 }
126 |                 Err(_) => (vec![], BaseRefConfigStatus::Invalid),
127 |             };
128 | 
129 |         Ok(ChangesSummary {
130 |             changes,
131 |             base_ref_config_status,
132 |         })
133 |     }
134 | 
135 |     /// [ServiceHandler::reconcile]
136 |     async fn reconcile(&self, org: &Organization) -> Result<ChangesApplied> {
137 |         // Get changes between the actual and the desired state
138 |         let ctx = Ctx::from(org);
139 |         let src = Source::from(org);
140 |         let actual_state = State::new_from_service(self.svc.clone(), &ctx)
141 |             .await
142 |             .context("error getting actual state from service")?;
143 |         let desired_state =
144 |             State::new_from_config(self.gh.clone(), self.svc.clone(), &org.legacy, &ctx, &src)
145 |                 .await
146 |                 .context("error getting desired state from configuration")?;
147 |         let changes = actual_state.diff(&desired_state);
148 |         debug!(?changes, "changes between the actual and the desired state");
149 | 
150 |         // Apply changes needed to match desired state
151 |         let mut changes_applied = vec![];
152 | 
153 |         // Apply directory changes
154 |         let ctx = Ctx::from(org);
155 |         for change in changes.directory {
156 |             let err = match &change {
157 |                 DirectoryChange::TeamAdded(team) => self.svc.add_team(&ctx, team).await.err(),
158 |                 DirectoryChange::TeamRemoved(team_name) => self.svc.remove_team(&ctx, team_name).await.err(),
159 |                 DirectoryChange::TeamMaintainerAdded(team_name, user_name) => {
160 |                     self.svc.add_team_maintainer(&ctx, team_name, user_name).await.err()
161 |                 }
162 |                 DirectoryChange::TeamMaintainerRemoved(team_name, user_name) => {
163 |                     self.svc.remove_team_maintainer(&ctx, team_name, user_name).await.err()
164 |                 }
165 |                 DirectoryChange::TeamMemberAdded(team_name, user_name) => {
166 |                     self.svc.add_team_member(&ctx, team_name, user_name).await.err()
167 |                 }
168 |                 DirectoryChange::TeamMemberRemoved(team_name, user_name) => {
169 |                     self.svc.remove_team_member(&ctx, team_name, user_name).await.err()
170 |                 }
171 |                 DirectoryChange::UserAdded(_)
172 |                 | DirectoryChange::UserRemoved(_)
173 |                 | DirectoryChange::UserUpdated(_) => continue,
174 |             };
175 |             changes_applied.push(ChangeApplied {
176 |                 change: Box::new(change),
177 |                 error: err.map(|e| e.to_string()),
178 |                 applied_at: time::OffsetDateTime::now_utc(),
179 |             });
180 |         }
181 | 
182 |         // Apply repositories changes
183 |         'changes_repositories: for change in changes.repositories {
184 |             let err = match &change {
185 |                 RepositoryChange::RepositoryAdded(repo) => self.svc.add_repository(&ctx, repo).await.err(),
186 |                 RepositoryChange::TeamAdded(repo_name, team_name, role) => {
187 |                     self.svc.add_repository_team(&ctx, repo_name, team_name, role).await.err()
188 |                 }
189 |                 RepositoryChange::TeamRemoved(repo_name, team_name) => {
190 |                     // If the team has just been deleted from the directory in
191 |                     // this reconciliation, there is no need to remove it from
192 |                     // the repository as this will be done automatically when
193 |                     // the team is deleted from GitHub
194 |                     for entry in &changes_applied {
195 |                         let change = (*entry.change).downcast_ref::<DirectoryChange>();
196 |                         if let Some(DirectoryChange::TeamRemoved(team_removed_name)) = change {
197 |                             if team_name == team_removed_name {
198 |                                 continue 'changes_repositories;
199 |                             }
200 |                         }
201 |                     }
202 | 
203 |                     self.svc.remove_repository_team(&ctx, repo_name, team_name).await.err()
204 |                 }
205 |                 RepositoryChange::TeamRoleUpdated(repo_name, team_name, role) => {
206 |                     self.svc.update_repository_team_role(&ctx, repo_name, team_name, role).await.err()
207 |                 }
208 |                 RepositoryChange::CollaboratorAdded(repo_name, user_name, role) => {
209 |                     self.svc.add_repository_collaborator(&ctx, repo_name, user_name, role).await.err()
210 |                 }
211 |                 RepositoryChange::CollaboratorRemoved(repo_name, user_name) => {
212 |                     if let Some(invitation_id) =
213 |                         self.get_repository_invitation(&ctx, repo_name, user_name).await?
214 |                     {
215 |                         self.svc.remove_repository_invitation(&ctx, repo_name, invitation_id).await.err()
216 |                     } else {
217 |                         self.svc.remove_repository_collaborator(&ctx, repo_name, user_name).await.err()
218 |                     }
219 |                 }
220 |                 RepositoryChange::CollaboratorRoleUpdated(repo_name, user_name, role) => {
221 |                     if let Some(invitation_id) =
222 |                         self.get_repository_invitation(&ctx, repo_name, user_name).await?
223 |                     {
224 |                         self.svc
225 |                             .update_repository_invitation(&ctx, repo_name, invitation_id, role)
226 |                             .await
227 |                             .err()
228 |                     } else {
229 |                         self.svc
230 |                             .update_repository_collaborator_role(&ctx, repo_name, user_name, role)
231 |                             .await
232 |                             .err()
233 |                     }
234 |                 }
235 |                 RepositoryChange::VisibilityUpdated(repo_name, visibility) => {
236 |                     self.svc.update_repository_visibility(&ctx, repo_name, visibility).await.err()
237 |                 }
238 |             };
239 |             changes_applied.push(ChangeApplied {
240 |                 change: Box::new(change),
241 |                 error: err.map(|e| e.to_string()),
242 |                 applied_at: time::OffsetDateTime::now_utc(),
243 |             });
244 |         }
245 | 
246 |         Ok(changes_applied)
247 |     }
248 | }
249 | 


--------------------------------------------------------------------------------
/clowarden-core/src/services/mod.rs:
--------------------------------------------------------------------------------
 1 | //! This module defines some types and traits that service handlers
 2 | //! implementations will rely upon.
 3 | 
 4 | use std::{fmt::Debug, sync::Arc};
 5 | 
 6 | use anyhow::Result;
 7 | use as_any::AsAny;
 8 | use async_trait::async_trait;
 9 | 
10 | use crate::{cfg::Organization, github::Source};
11 | 
12 | pub mod github;
13 | 
14 | /// Type alias to represent a service name.
15 | pub type ServiceName = &'static str;
16 | 
17 | /// Trait that defines some operations a service handler must support.
18 | #[async_trait]
19 | pub trait ServiceHandler {
20 |     /// Return a summary of the changes detected in the service's state as
21 |     /// defined in the configuration from the base to the head reference.
22 |     async fn get_changes_summary(&self, org: &Organization, head_src: &Source) -> Result<ChangesSummary>;
23 | 
24 |     /// Apply the changes needed so that the actual state (as defined in the
25 |     /// service) matches the desired state (as defined in the configuration).
26 |     async fn reconcile(&self, org: &Organization) -> Result<ChangesApplied>;
27 | }
28 | 
29 | /// Type alias to represent a service handler trait object.
30 | pub type DynServiceHandler = Arc<dyn ServiceHandler + Send + Sync>;
31 | 
32 | /// Represents a summary of changes detected in the service's state as defined
33 | /// in the configuration from the base to the head reference.
34 | pub struct ChangesSummary {
35 |     pub changes: Vec<DynChange>,
36 |     pub base_ref_config_status: BaseRefConfigStatus,
37 | }
38 | 
39 | /// Type alias to represent some changes applied on a service.
40 | pub type ChangesApplied = Vec<ChangeApplied>;
41 | 
42 | /// Represents a change applied on a service in an attempt to get closer to the
43 | /// desired state.
44 | #[derive(Debug)]
45 | pub struct ChangeApplied {
46 |     pub change: DynChange,
47 |     pub error: Option<String>,
48 |     pub applied_at: time::OffsetDateTime,
49 | }
50 | 
51 | /// Trait that defines some operations a Change implementation must support.
52 | pub trait Change: AsAny + Debug {
53 |     /// Return some details about the change.
54 |     fn details(&self) -> ChangeDetails;
55 | 
56 |     /// Keywords used to facilitate locating specific changes on searches.
57 |     fn keywords(&self) -> Vec<&str>;
58 | 
59 |     /// Format change to be used on a template.
60 |     fn template_format(&self) -> Result<String>;
61 | }
62 | 
63 | /// Type alias to represent a change trait object.
64 | pub type DynChange = Box<dyn Change + Send + Sync>;
65 | 
66 | /// Status of the configuration in the base reference.
67 | #[derive(Debug, Clone, PartialEq)]
68 | pub enum BaseRefConfigStatus {
69 |     Valid,
70 |     Invalid,
71 |     Unknown,
72 | }
73 | 
74 | impl BaseRefConfigStatus {
75 |     /// Check if the configuration is invalid.
76 |     #[must_use]
77 |     pub fn is_invalid(&self) -> bool {
78 |         *self == BaseRefConfigStatus::Invalid
79 |     }
80 | }
81 | 
82 | /// ChangeDetails represents some details about a change.
83 | #[derive(Debug, Clone, PartialEq)]
84 | pub struct ChangeDetails {
85 |     pub kind: String,
86 |     pub extra: serde_json::Value,
87 | }
88 | 


--------------------------------------------------------------------------------
/clowarden-server/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "clowarden-server"
 3 | description = "CLOWarden server"
 4 | version.workspace = true
 5 | license.workspace = true
 6 | edition.workspace = true
 7 | rust-version.workspace = true
 8 | 
 9 | [dependencies]
10 | anyhow = { workspace = true }
11 | askama = { workspace = true }
12 | async-trait = { workspace = true }
13 | axum = { workspace = true }
14 | cached = { workspace = true }
15 | clap = { workspace = true }
16 | clowarden-core = { path = "../clowarden-core" }
17 | deadpool-postgres = { workspace = true }
18 | figment = { workspace = true }
19 | futures = { workspace = true }
20 | hmac = { workspace = true }
21 | hex = { workspace = true }
22 | mime = { workspace = true }
23 | mockall = { workspace = true }
24 | octorust = { workspace = true }
25 | openssl = { workspace = true }
26 | pem = { workspace = true }
27 | postgres-openssl = { workspace = true }
28 | regex = { workspace = true }
29 | serde = { workspace = true }
30 | serde_json = { workspace = true }
31 | serde_qs = { workspace = true }
32 | serde_yaml = { workspace = true }
33 | sha2 = { workspace = true }
34 | thiserror = { workspace = true }
35 | time = { workspace = true }
36 | tokio = { workspace = true }
37 | tokio-postgres = { workspace = true }
38 | tokio-util = { workspace = true }
39 | tower = { workspace = true }
40 | tower-http = { workspace = true }
41 | tracing = { workspace = true }
42 | tracing-subscriber = { workspace = true }
43 | uuid = { workspace = true }
44 | 
45 | [dev-dependencies]
46 | mockall = { workspace = true }
47 | 


--------------------------------------------------------------------------------
/clowarden-server/Dockerfile:
--------------------------------------------------------------------------------
 1 | # Build clowarden
 2 | FROM rust:1-alpine3.21 AS builder
 3 | RUN apk --no-cache add musl-dev perl make
 4 | WORKDIR /clowarden
 5 | COPY Cargo.* ./
 6 | COPY clowarden-cli/Cargo.* clowarden-cli
 7 | COPY clowarden-core clowarden-core
 8 | COPY clowarden-server clowarden-server
 9 | WORKDIR /clowarden/clowarden-server
10 | RUN cargo build --release
11 | 
12 | # Build frontend
13 | FROM node:22-alpine3.21 AS frontend-builder
14 | RUN apk --no-cache add git
15 | WORKDIR /web
16 | COPY web .
17 | ENV NODE_OPTIONS=--max_old_space_size=4096
18 | RUN yarn config set network-timeout 1000000
19 | RUN yarn install --network-concurrency 1
20 | RUN yarn build
21 | 
22 | # Final stage
23 | FROM alpine:3.21.3
24 | RUN apk --no-cache add ca-certificates && addgroup -S clowarden && adduser -S clowarden -G clowarden
25 | USER clowarden
26 | WORKDIR /home/clowarden
27 | COPY --from=builder /clowarden/target/release/clowarden-server /usr/local/bin
28 | COPY --from=frontend-builder /web/build ./web/build
29 | 


--------------------------------------------------------------------------------
/clowarden-server/src/cfg.rs:
--------------------------------------------------------------------------------
 1 | //! This module defines some types to represent the configuration.
 2 | 
 3 | use std::path::{Path, PathBuf};
 4 | 
 5 | use anyhow::Result;
 6 | use deadpool_postgres::Config as Db;
 7 | use figment::{
 8 |     providers::{Env, Format, Serialized, Yaml},
 9 |     Figment,
10 | };
11 | use serde::{Deserialize, Serialize};
12 | 
13 | use clowarden_core::cfg::{GitHubApp, Organization, Services};
14 | 
15 | /// Server configuration.
16 | #[derive(Debug, Clone, Deserialize, Serialize)]
17 | pub(crate) struct Config {
18 |     pub db: Db,
19 |     pub log: Log,
20 |     pub server: HttpServer,
21 |     pub services: Services,
22 |     pub organizations: Option<Vec<Organization>>,
23 | }
24 | 
25 | impl Config {
26 |     /// Create a new Config instance.
27 |     pub(crate) fn new(config_file: &Path) -> Result<Self> {
28 |         Figment::new()
29 |             .merge(Serialized::default("log.format", "pretty"))
30 |             .merge(Serialized::default("server.addr", "127.0.0.1:9000"))
31 |             .merge(Yaml::file(config_file))
32 |             .merge(Env::prefixed("CLOWARDEN_").split("_").lowercase(false))
33 |             .extract()
34 |             .map_err(Into::into)
35 |     }
36 | }
37 | 
38 | /// Logs configuration.
39 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
40 | pub(crate) struct Log {
41 |     pub format: LogFormat,
42 | }
43 | 
44 | /// Format to use in logs.
45 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
46 | #[serde(rename_all(deserialize = "lowercase"))]
47 | pub(crate) enum LogFormat {
48 |     Json,
49 |     Pretty,
50 | }
51 | 
52 | /// Http server configuration.
53 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
54 | #[serde(rename_all(deserialize = "camelCase"))]
55 | pub(crate) struct HttpServer {
56 |     pub addr: String,
57 |     pub static_path: PathBuf,
58 |     pub basic_auth: Option<BasicAuth>,
59 |     pub github_app: GitHubApp,
60 | }
61 | 
62 | /// Basic authentication configuration.
63 | #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
64 | pub(crate) struct BasicAuth {
65 |     pub enabled: bool,
66 |     pub username: String,
67 |     pub password: String,
68 | }
69 | 


--------------------------------------------------------------------------------
/clowarden-server/src/db.rs:
--------------------------------------------------------------------------------
  1 | //! This module defines an abstraction layer over the database.
  2 | 
  3 | use std::{collections::HashMap, fmt::Write, sync::Arc};
  4 | 
  5 | use anyhow::{Error, Result};
  6 | use async_trait::async_trait;
  7 | use deadpool_postgres::Pool;
  8 | #[cfg(test)]
  9 | use mockall::automock;
 10 | use serde::{Deserialize, Serialize};
 11 | use tokio_postgres::types::Json;
 12 | use uuid::Uuid;
 13 | 
 14 | use clowarden_core::services::{ChangesApplied, ServiceName};
 15 | 
 16 | use crate::jobs::ReconcileInput;
 17 | 
 18 | /// Trait that defines some operations a DB implementation must support.
 19 | #[async_trait]
 20 | #[cfg_attr(test, automock)]
 21 | pub(crate) trait DB {
 22 |     /// Register the reconciliation provided.
 23 |     async fn register_reconciliation(
 24 |         &self,
 25 |         input: &ReconcileInput,
 26 |         changes_applied: &HashMap<ServiceName, ChangesApplied>,
 27 |         errors: &HashMap<ServiceName, Error>,
 28 |     ) -> Result<()>;
 29 | 
 30 |     /// Search changes that match the criteria provided.
 31 |     async fn search_changes(&self, input: &SearchChangesInput) -> Result<(Count, JsonString)>;
 32 | }
 33 | 
 34 | /// Type alias to represent a DB trait object.
 35 | pub(crate) type DynDB = Arc<dyn DB + Send + Sync>;
 36 | 
 37 | /// Type alias to represent a counter value.
 38 | type Count = i64;
 39 | 
 40 | /// Type alias to represent a json string.
 41 | type JsonString = String;
 42 | 
 43 | /// DB implementation backed by PostgreSQL.
 44 | pub(crate) struct PgDB {
 45 |     pool: Pool,
 46 | }
 47 | 
 48 | impl PgDB {
 49 |     /// Create a new PgDB instance.
 50 |     pub(crate) fn new(pool: Pool) -> Self {
 51 |         Self { pool }
 52 |     }
 53 | }
 54 | 
 55 | #[async_trait]
 56 | impl DB for PgDB {
 57 |     /// [DB::register_reconciliation]
 58 |     async fn register_reconciliation(
 59 |         &self,
 60 |         input: &ReconcileInput,
 61 |         changes_applied: &HashMap<ServiceName, ChangesApplied>,
 62 |         errors: &HashMap<ServiceName, Error>,
 63 |     ) -> Result<()> {
 64 |         let mut db = self.pool.get().await?;
 65 |         let tx = db.transaction().await?;
 66 | 
 67 |         // Prepare reconciliation errors summary
 68 |         let errors_summary = if errors.is_empty() {
 69 |             None
 70 |         } else {
 71 |             let mut summary = String::new();
 72 |             for (i, (service_name, error)) in errors.iter().enumerate() {
 73 |                 write!(&mut summary, "{service_name}: {error:?}")?;
 74 |                 if errors.len() > i + 1 {
 75 |                     summary.push('\n');
 76 |                 }
 77 |             }
 78 |             Some(summary)
 79 |         };
 80 | 
 81 |         // Register reconciliation entry
 82 |         let reconciliation_id: Uuid = tx
 83 |             .query_one(
 84 |                 "
 85 |                 insert into reconciliation (
 86 |                     error,
 87 |                     organization,
 88 |                     pr_number,
 89 |                     pr_created_by,
 90 |                     pr_merged_by,
 91 |                     pr_merged_at
 92 |                 ) values (
 93 |                     $1::text,
 94 |                     $2::text,
 95 |                     $3::bigint,
 96 |                     $4::text,
 97 |                     $5::text,
 98 |                     $6::timestamptz
 99 |                 )
100 |                 returning reconciliation_id
101 |                 ",
102 |                 &[
103 |                     &errors_summary,
104 |                     &input.org.name,
105 |                     &input.pr_number,
106 |                     &input.pr_created_by,
107 |                     &input.pr_merged_by,
108 |                     &input.pr_merged_at,
109 |                 ],
110 |             )
111 |             .await?
112 |             .get("reconciliation_id");
113 | 
114 |         // Prepare reconciliation keywords
115 |         let mut reconciliation_keywords: Vec<&str> = vec![];
116 |         let pr_number: String;
117 |         if let Some(value) = &input.pr_number {
118 |             pr_number = value.to_string();
119 |             reconciliation_keywords.push(&pr_number);
120 |         }
121 |         if let Some(user_name) = &input.pr_created_by {
122 |             reconciliation_keywords.push(user_name);
123 |         }
124 |         if let Some(user_name) = &input.pr_merged_by {
125 |             reconciliation_keywords.push(user_name);
126 |         }
127 | 
128 |         // Register changes
129 |         for (service_name, service_changes_applied) in changes_applied {
130 |             for change_applied in service_changes_applied {
131 |                 let change_details = change_applied.change.details();
132 |                 let mut change_keywords = reconciliation_keywords.clone();
133 |                 change_keywords.extend_from_slice(change_applied.change.keywords().as_ref());
134 | 
135 |                 tx.execute(
136 |                     "
137 |                     insert into change (
138 |                         service,
139 |                         kind,
140 |                         extra,
141 |                         applied_at,
142 |                         error,
143 |                         reconciliation_id,
144 |                         tsdoc
145 |                     ) values (
146 |                         $1::text,
147 |                         $2::text,
148 |                         $3::jsonb,
149 |                         $4::timestamptz,
150 |                         $5::text,
151 |                         $6::uuid,
152 |                         to_tsvector($7::text)
153 |                     )
154 |                     ",
155 |                     &[
156 |                         service_name,
157 |                         &change_details.kind,
158 |                         &change_details.extra,
159 |                         &change_applied.applied_at,
160 |                         &change_applied.error,
161 |                         &reconciliation_id,
162 |                         &change_keywords.join(" "),
163 |                     ],
164 |                 )
165 |                 .await?;
166 |             }
167 |         }
168 | 
169 |         tx.commit().await?;
170 |         Ok(())
171 |     }
172 | 
173 |     /// [DB::search_changes]
174 |     async fn search_changes(&self, input: &SearchChangesInput) -> Result<(Count, JsonString)> {
175 |         let db = self.pool.get().await?;
176 |         let row = db
177 |             .query_one(
178 |                 "select total_count, changes::text from search_changes($1::jsonb)",
179 |                 &[&Json(input)],
180 |             )
181 |             .await?;
182 |         let count: i64 = row.get("total_count");
183 |         let changes: String = row.get("changes");
184 |         Ok((count, changes))
185 |     }
186 | }
187 | 
188 | /// Query input used when searching for changes.
189 | #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
190 | pub(crate) struct SearchChangesInput {
191 |     pub limit: Option<usize>,
192 |     pub offset: Option<usize>,
193 |     pub sort_by: Option<String>,
194 |     pub sort_direction: Option<String>,
195 |     pub organization: Option<String>,
196 |     pub service: Option<Vec<String>>,
197 |     pub kind: Option<Vec<String>>,
198 |     pub applied_from: Option<String>,
199 |     pub applied_to: Option<String>,
200 |     pub pr_number: Option<Vec<i64>>,
201 |     pub pr_merged_by: Option<Vec<String>>,
202 |     pub applied_successfully: Option<bool>,
203 |     pub ts_query_web: Option<String>,
204 | }
205 | 


--------------------------------------------------------------------------------
/clowarden-server/src/github.rs:
--------------------------------------------------------------------------------
  1 | //! This module defines an abstraction layer over the GitHub API.
  2 | 
  3 | use std::sync::Arc;
  4 | 
  5 | use anyhow::{Context, Result};
  6 | use async_trait::async_trait;
  7 | use axum::http::HeaderValue;
  8 | #[cfg(test)]
  9 | use mockall::automock;
 10 | use octorust::{
 11 |     auth::{Credentials, InstallationTokenGenerator, JWTCredentials},
 12 |     types::{
 13 |         ChecksCreateRequest, ChecksCreateRequestConclusion, ChecksCreateRequestOutput, JobStatus,
 14 |         OrganizationSimple, PullRequestData, PullsUpdateReviewRequest, Repository, SimpleUser,
 15 |     },
 16 |     Client,
 17 | };
 18 | use serde::{Deserialize, Serialize};
 19 | use thiserror::Error;
 20 | 
 21 | use clowarden_core::cfg::{GitHubApp, Organization};
 22 | 
 23 | /// Name used for the check run in GitHub.
 24 | const CHECK_RUN_NAME: &str = "CLOWarden";
 25 | 
 26 | /// Trait that defines some operations a GH implementation must support.
 27 | #[async_trait]
 28 | #[cfg_attr(test, automock)]
 29 | pub(crate) trait GH {
 30 |     /// Create a check run.
 31 |     async fn create_check_run(&self, ctx: &Ctx, body: &ChecksCreateRequest) -> Result<()>;
 32 | 
 33 |     /// List pull request files.
 34 |     async fn list_pr_files(&self, ctx: &Ctx, pr_number: i64) -> Result<Vec<FileName>>;
 35 | 
 36 |     /// Post the comment provided in the repository's pull request given.
 37 |     async fn post_comment(&self, ctx: &Ctx, pr_number: i64, body: &str) -> Result<CommentId>;
 38 | }
 39 | 
 40 | /// Type alias to represent a GH trait object.
 41 | pub(crate) type DynGH = Arc<dyn GH + Send + Sync>;
 42 | 
 43 | /// Type alias to represent a comment id.
 44 | type CommentId = i64;
 45 | 
 46 | /// Type alias to represent a filename.
 47 | type FileName = String;
 48 | 
 49 | /// GH implementation backed by the GitHub API.
 50 | pub(crate) struct GHApi {
 51 |     app_credentials: JWTCredentials,
 52 | }
 53 | 
 54 | impl GHApi {
 55 |     /// Create a new GHApi instance.
 56 |     pub(crate) fn new(gh_app: &GitHubApp) -> Result<Self> {
 57 |         // Setup GitHub app credentials
 58 |         let private_key = pem::parse(&gh_app.private_key)?.contents().to_owned();
 59 |         let app_credentials =
 60 |             JWTCredentials::new(gh_app.app_id, private_key).context("error setting up credentials")?;
 61 | 
 62 |         Ok(Self { app_credentials })
 63 |     }
 64 | 
 65 |     /// Setup GitHub API client for the installation id provided.
 66 |     fn setup_client(&self, inst_id: i64) -> Result<Client> {
 67 |         let user_agent = format!("{}/{}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
 68 |         let tg = InstallationTokenGenerator::new(inst_id, self.app_credentials.clone());
 69 |         let credentials = Credentials::InstallationToken(tg);
 70 | 
 71 |         Ok(Client::new(user_agent, credentials)?)
 72 |     }
 73 | }
 74 | 
 75 | #[async_trait]
 76 | impl GH for GHApi {
 77 |     /// [GH::create_check_run]
 78 |     async fn create_check_run(&self, ctx: &Ctx, body: &ChecksCreateRequest) -> Result<()> {
 79 |         let client = self.setup_client(ctx.inst_id)?;
 80 |         _ = client.checks().create(&ctx.owner, &ctx.repo, body).await?;
 81 |         Ok(())
 82 |     }
 83 | 
 84 |     /// [GH::list_pr_files]
 85 |     async fn list_pr_files(&self, ctx: &Ctx, pr_number: i64) -> Result<Vec<FileName>> {
 86 |         let client = self.setup_client(ctx.inst_id)?;
 87 |         let files = client
 88 |             .pulls()
 89 |             .list_all_files(&ctx.owner, &ctx.repo, pr_number)
 90 |             .await?
 91 |             .iter()
 92 |             .map(|e| e.filename.clone())
 93 |             .collect();
 94 |         Ok(files)
 95 |     }
 96 | 
 97 |     /// [GH::post_comment]
 98 |     async fn post_comment(&self, ctx: &Ctx, pr_number: i64, body: &str) -> Result<CommentId> {
 99 |         let body = &PullsUpdateReviewRequest {
100 |             body: body.to_string(),
101 |         };
102 |         let client = self.setup_client(ctx.inst_id)?;
103 |         let comment = client.issues().create_comment(&ctx.owner, &ctx.repo, pr_number, body).await?;
104 |         Ok(comment.id)
105 |     }
106 | }
107 | 
108 | /// Type alias to represent a webhook event header.
109 | type EventHeader = Option<HeaderValue>;
110 | 
111 | /// Type alias to represent a webhook event payload.
112 | type EventPayload = [u8];
113 | 
114 | /// Represents a GitHub webhook event.
115 | #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
116 | pub(crate) enum Event {
117 |     PullRequest(PullRequestEvent),
118 | }
119 | 
120 | impl TryFrom<(&EventHeader, &EventPayload)> for Event {
121 |     type Error = EventError;
122 | 
123 |     fn try_from((event_name, event_body): (&EventHeader, &EventPayload)) -> Result<Self, Self::Error> {
124 |         match event_name {
125 |             Some(event_name) => match event_name.as_bytes() {
126 |                 b"pull_request" => {
127 |                     let event: PullRequestEvent = serde_json::from_slice(event_body)
128 |                         .map_err(|err| EventError::InvalidBody(err.to_string()))?;
129 |                     Ok(Event::PullRequest(event))
130 |                 }
131 |                 _ => Err(EventError::UnsupportedEvent),
132 |             },
133 |             None => Err(EventError::MissingHeader),
134 |         }
135 |     }
136 | }
137 | 
138 | /// Errors that may occur while creating a new webhook event instance.
139 | #[derive(Error, Debug, Clone, PartialEq, Serialize, Deserialize)]
140 | pub(crate) enum EventError {
141 |     #[error("event header missing")]
142 |     MissingHeader,
143 |     #[error("unsupported event")]
144 |     UnsupportedEvent,
145 |     #[error("invalid body: {0}")]
146 |     InvalidBody(String),
147 | }
148 | 
149 | /// Pull request event payload.
150 | #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
151 | pub(crate) struct PullRequestEvent {
152 |     pub action: PullRequestEventAction,
153 |     pub number: i64,
154 |     pub organization: Option<OrganizationSimple>,
155 |     pub pull_request: PullRequestData,
156 |     pub repository: Repository,
157 |     pub sender: SimpleUser,
158 | }
159 | 
160 | /// Pull request event action.
161 | #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
162 | #[serde(rename_all = "snake_case")]
163 | pub(crate) enum PullRequestEventAction {
164 |     Closed,
165 |     Opened,
166 |     Synchronize,
167 |     #[serde(other)]
168 |     Other,
169 | }
170 | 
171 | /// Helper function to create a new ChecksCreateRequest instance.
172 | pub(crate) fn new_checks_create_request(
173 |     head_sha: String,
174 |     status: Option<JobStatus>,
175 |     conclusion: Option<ChecksCreateRequestConclusion>,
176 |     msg: &str,
177 | ) -> ChecksCreateRequest {
178 |     ChecksCreateRequest {
179 |         actions: vec![],
180 |         completed_at: None,
181 |         conclusion,
182 |         details_url: String::new(),
183 |         external_id: String::new(),
184 |         head_sha,
185 |         name: CHECK_RUN_NAME.to_string(),
186 |         output: Some(ChecksCreateRequestOutput {
187 |             annotations: vec![],
188 |             images: vec![],
189 |             summary: msg.to_string(),
190 |             text: String::new(),
191 |             title: msg.to_string(),
192 |         }),
193 |         started_at: None,
194 |         status,
195 |     }
196 | }
197 | 
198 | /// Information about the target of a GitHub API request.
199 | pub struct Ctx {
200 |     pub inst_id: i64,
201 |     pub owner: String,
202 |     pub repo: String,
203 | }
204 | 
205 | impl From<&Organization> for Ctx {
206 |     fn from(org: &Organization) -> Self {
207 |         Ctx {
208 |             inst_id: org.installation_id,
209 |             owner: org.name.clone(),
210 |             repo: org.repository.clone(),
211 |         }
212 |     }
213 | }
214 | 


--------------------------------------------------------------------------------
/clowarden-server/src/main.rs:
--------------------------------------------------------------------------------
  1 | #![warn(clippy::all, clippy::pedantic)]
  2 | #![allow(clippy::doc_markdown, clippy::similar_names)]
  3 | 
  4 | use std::{collections::HashMap, net::SocketAddr, path::PathBuf, sync::Arc};
  5 | 
  6 | use anyhow::{Context, Result};
  7 | use cfg::{Config, LogFormat};
  8 | use clap::Parser;
  9 | use db::DynDB;
 10 | use deadpool_postgres::Runtime;
 11 | use futures::future;
 12 | use github::DynGH;
 13 | use openssl::ssl::{SslConnector, SslMethod, SslVerifyMode};
 14 | use postgres_openssl::MakeTlsConnector;
 15 | use tokio::{net::TcpListener, signal, sync::mpsc};
 16 | use tokio_util::sync::CancellationToken;
 17 | use tracing::{error, info};
 18 | use tracing_subscriber::EnvFilter;
 19 | 
 20 | use clowarden_core::{
 21 |     self as core,
 22 |     services::{self, DynServiceHandler, ServiceName},
 23 | };
 24 | 
 25 | use crate::db::PgDB;
 26 | 
 27 | mod cfg;
 28 | mod db;
 29 | mod github;
 30 | mod handlers;
 31 | mod jobs;
 32 | mod tmpl;
 33 | 
 34 | #[derive(Debug, Parser)]
 35 | #[clap(author, version, about)]
 36 | struct Args {
 37 |     /// Config file path
 38 |     #[clap(short, long)]
 39 |     config: PathBuf,
 40 | }
 41 | 
 42 | #[tokio::main]
 43 | async fn main() -> Result<()> {
 44 |     let args = Args::parse();
 45 | 
 46 |     // Setup configuration
 47 |     let cfg = Config::new(&args.config).context("error setting up configuration")?;
 48 | 
 49 |     // Setup logging
 50 |     if std::env::var_os("RUST_LOG").is_none() {
 51 |         std::env::set_var("RUST_LOG", "clowarden=debug");
 52 |     }
 53 |     let ts = tracing_subscriber::fmt().with_env_filter(EnvFilter::from_default_env());
 54 |     match cfg.log.format {
 55 |         LogFormat::Json => ts.json().init(),
 56 |         LogFormat::Pretty => ts.init(),
 57 |     }
 58 | 
 59 |     // Setup database
 60 |     let mut builder = SslConnector::builder(SslMethod::tls())?;
 61 |     builder.set_verify(SslVerifyMode::NONE);
 62 |     let connector = MakeTlsConnector::new(builder.build());
 63 |     let pool = cfg.db.create_pool(Some(Runtime::Tokio1), connector)?;
 64 |     let db: DynDB = Arc::new(PgDB::new(pool));
 65 | 
 66 |     // Setup GitHub clients
 67 |     let gh_app = &cfg.server.github_app;
 68 |     let gh: DynGH = Arc::new(github::GHApi::new(gh_app).context("error setting up github client")?);
 69 |     let ghc: core::github::DynGH = Arc::new(
 70 |         core::github::GHApi::new_with_app_creds(gh_app).context("error setting up core github client")?,
 71 |     );
 72 | 
 73 |     // Setup services handlers
 74 |     let mut services: HashMap<ServiceName, DynServiceHandler> = HashMap::new();
 75 |     if cfg.services.github.enabled {
 76 |         let svc = Arc::new(services::github::service::SvcApi::new_with_app_creds(gh_app)?);
 77 |         services.insert(
 78 |             services::github::SERVICE_NAME,
 79 |             Arc::new(services::github::Handler::new(ghc.clone(), svc)),
 80 |         );
 81 |     }
 82 | 
 83 |     // Setup and launch jobs workers
 84 |     let orgs = cfg.organizations.clone().unwrap_or_default();
 85 |     let cancel_token = CancellationToken::new();
 86 |     let (jobs_tx, jobs_rx) = mpsc::unbounded_channel();
 87 |     let jobs_handler = jobs::handler(&db, &gh, &ghc, &services, jobs_rx, cancel_token.clone(), &orgs);
 88 |     let jobs_scheduler = jobs::scheduler(jobs_tx.clone(), cancel_token.clone(), &orgs);
 89 |     let jobs_workers_done = future::join_all([jobs_handler, jobs_scheduler]);
 90 | 
 91 |     // Setup and launch HTTP server
 92 |     let router = handlers::setup_router(&cfg, db.clone(), gh.clone(), jobs_tx)
 93 |         .context("error setting up http server router")?;
 94 |     let addr: SocketAddr = cfg.server.addr.parse()?;
 95 |     let listener = TcpListener::bind(addr).await?;
 96 |     info!("server started");
 97 |     info!(%addr, "listening");
 98 |     if let Err(err) = axum::serve(listener, router).with_graceful_shutdown(shutdown_signal()).await {
 99 |         error!(?err, "server error");
100 |         return Err(err.into());
101 |     }
102 | 
103 |     // Ask jobs workers to stop and wait for them to finish
104 |     cancel_token.cancel();
105 |     jobs_workers_done.await;
106 |     info!("server stopped");
107 | 
108 |     Ok(())
109 | }
110 | 
111 | /// Return a future that will complete when the program is asked to stop via a
112 | /// ctrl+c or terminate signal.
113 | async fn shutdown_signal() {
114 |     // Setup signal handlers
115 |     let ctrl_c = async {
116 |         signal::ctrl_c().await.expect("failed to install ctrl+c signal handler");
117 |     };
118 | 
119 |     #[cfg(unix)]
120 |     let terminate = async {
121 |         signal::unix::signal(signal::unix::SignalKind::terminate())
122 |             .expect("failed to install terminate signal handler")
123 |             .recv()
124 |             .await;
125 |     };
126 | 
127 |     #[cfg(not(unix))]
128 |     let terminate = std::future::pending::<()>();
129 | 
130 |     // Wait for any of the signals
131 |     tokio::select! {
132 |         () = ctrl_c => {},
133 |         () = terminate => {},
134 |     }
135 | }
136 | 


--------------------------------------------------------------------------------
/clowarden-server/src/tmpl.rs:
--------------------------------------------------------------------------------
  1 | //! This module defines the templates used to render the comments that
  2 | //! CLOWarden will post to GitHub.
  3 | 
  4 | use std::collections::HashMap;
  5 | 
  6 | use anyhow::Error;
  7 | use askama::Template;
  8 | 
  9 | use clowarden_core::services::{ChangesApplied, ChangesSummary, ServiceName};
 10 | 
 11 | /// Template for the reconciliation completed comment.
 12 | #[derive(Template)]
 13 | #[template(path = "reconciliation-completed.md")]
 14 | pub(crate) struct ReconciliationCompleted<'a> {
 15 |     services: Vec<ServiceName>,
 16 |     changes_applied: &'a HashMap<ServiceName, ChangesApplied>,
 17 |     some_changes_applied: bool,
 18 |     errors: &'a HashMap<ServiceName, Error>,
 19 |     errors_found: bool,
 20 | }
 21 | 
 22 | impl<'a> ReconciliationCompleted<'a> {
 23 |     pub(crate) fn new(
 24 |         changes_applied: &'a HashMap<ServiceName, ChangesApplied>,
 25 |         errors: &'a HashMap<ServiceName, Error>,
 26 |     ) -> Self {
 27 |         let services = changes_applied.keys().chain(errors.keys()).copied().collect();
 28 |         let some_changes_applied = (|| {
 29 |             for service_changes_applied in changes_applied.values() {
 30 |                 if !service_changes_applied.is_empty() {
 31 |                     return true;
 32 |                 }
 33 |             }
 34 |             false
 35 |         })();
 36 |         let errors_found = (|| {
 37 |             if !errors.is_empty() {
 38 |                 return true;
 39 |             }
 40 |             for service_changes_applied in changes_applied.values() {
 41 |                 for change_applied in service_changes_applied {
 42 |                     if change_applied.error.is_some() {
 43 |                         return true;
 44 |                     }
 45 |                 }
 46 |             }
 47 |             false
 48 |         })();
 49 |         Self {
 50 |             services,
 51 |             changes_applied,
 52 |             some_changes_applied,
 53 |             errors,
 54 |             errors_found,
 55 |         }
 56 |     }
 57 | }
 58 | 
 59 | /// Template for the validation failed comment.
 60 | #[derive(Template)]
 61 | #[template(path = "validation-failed.md")]
 62 | pub(crate) struct ValidationFailed<'a> {
 63 |     err: &'a Error,
 64 | }
 65 | 
 66 | impl<'a> ValidationFailed<'a> {
 67 |     pub(crate) fn new(err: &'a Error) -> Self {
 68 |         Self { err }
 69 |     }
 70 | }
 71 | 
 72 | /// Template for the validation succeeded comment.
 73 | #[derive(Template)]
 74 | #[template(path = "validation-succeeded.md")]
 75 | pub(crate) struct ValidationSucceeded<'a> {
 76 |     directory_changes: &'a ChangesSummary,
 77 |     services_changes: &'a HashMap<ServiceName, ChangesSummary>,
 78 |     changes_found: bool,
 79 |     invalid_base_ref_config_found: bool,
 80 | }
 81 | 
 82 | impl<'a> ValidationSucceeded<'a> {
 83 |     pub(crate) fn new(
 84 |         directory_changes: &'a ChangesSummary,
 85 |         services_changes: &'a HashMap<ServiceName, ChangesSummary>,
 86 |     ) -> Self {
 87 |         let changes_found = (|| {
 88 |             if !directory_changes.changes.is_empty() {
 89 |                 return true;
 90 |             }
 91 |             for summary in services_changes.values() {
 92 |                 if !summary.changes.is_empty() {
 93 |                     return true;
 94 |                 }
 95 |             }
 96 |             false
 97 |         })();
 98 |         let invalid_base_ref_config_found = (|| {
 99 |             if directory_changes.base_ref_config_status.is_invalid() {
100 |                 return true;
101 |             }
102 |             for summary in services_changes.values() {
103 |                 if summary.base_ref_config_status.is_invalid() {
104 |                     return true;
105 |                 }
106 |             }
107 |             false
108 |         })();
109 |         Self {
110 |             directory_changes,
111 |             services_changes,
112 |             changes_found,
113 |             invalid_base_ref_config_found,
114 |         }
115 |     }
116 | }
117 | 
118 | mod filters {
119 |     use anyhow::Error;
120 |     use clowarden_core::multierror;
121 | 
122 |     /// Template filter that formats the error provided.
123 |     pub(crate) fn format_error(err: &Error, _: &dyn askama::Values) -> askama::Result<String> {
124 |         match multierror::format_error(err) {
125 |             Ok(s) => Ok(s),
126 |             Err(err) => Err(askama::Error::Custom(err.into())),
127 |         }
128 |     }
129 | }
130 | 


--------------------------------------------------------------------------------
/clowarden-server/templates/reconciliation-completed.md:
--------------------------------------------------------------------------------
 1 | ## Reconciliation completed
 2 | {% if !errors_found ~%}
 3 |   #### ✅ The reconciliation completed successfully and all changes have been applied across the services!
 4 |   {{~ "" +}}
 5 |   {{~ "## Changes applied" -}}
 6 | 
 7 |   {% for (service_name, changes) in changes_applied %}
 8 |     {% if !changes.is_empty() ~%}
 9 |       ### {{ service_name|capitalize }}
10 | 
11 |       {%~ for change_applied in changes %}
12 |         {{~ change_applied.change.template_format().unwrap() -}}
13 |       {% endfor %}
14 |     {% endif %}
15 |   {%- endfor %}
16 | 
17 |   {%- if !some_changes_applied ~%}
18 |     No actionable changes detected.
19 |   {% endif -%}
20 | 
21 | {% else ~%}
22 |   #### ‼️ Some errors were found during the reconciliation
23 |   {% for service_name in services ~%}
24 |     ## {{ service_name|capitalize -}}
25 | 
26 |     {% if changes_applied.get(service_name.to_owned()).is_some() %}
27 |       {% for change_applied in changes_applied.get(service_name.to_owned()).unwrap() %}
28 |         {%- if change_applied.error.is_some() ~%}
29 |           - Error applying change: **{{ "{:?}"|format(change_applied.change) }}**
30 | 
31 |           {{~ "```" +}}
32 |           {{~ change_applied.error.as_ref().unwrap() }}
33 |           {{~ "```" +}}
34 |         {% endif -%}
35 |       {% endfor %}
36 |     {% endif %}
37 | 
38 |     {% if errors.get(service_name.to_owned()).is_some() %}
39 |       {{~ "Errors:" -}}
40 | 
41 |       {% for error in errors.get(service_name.to_owned()) %}
42 |         {{ error|format_error }}
43 |       {% endfor %}
44 |     {%- endif %}
45 |   {%- endfor %}
46 | {% endif -%}
47 | 


--------------------------------------------------------------------------------
/clowarden-server/templates/validation-failed.md:
--------------------------------------------------------------------------------
 1 | ## Validation failed
 2 | 
 3 | #### ‼️ Some errors were found validating the configuration files
 4 | 
 5 | ***
 6 | 
 7 | Errors:
 8 | {{ err|format_error }}
 9 | 
10 | ***
11 | 
12 | For more details about the configuration files format please see the [documentation](https://github.com/cncf/clowarden).
13 | 
14 | 🔺 **These errors must be addressed before this PR can be merged** 🔺
15 | 


--------------------------------------------------------------------------------
/clowarden-server/templates/validation-succeeded.md:
--------------------------------------------------------------------------------
 1 | ## Validation succeeded
 2 | 
 3 | #### ✅ The proposed configuration changes are valid!
 4 | 
 5 | ## Configuration changes
 6 | 
 7 | {% if !invalid_base_ref_config_found && !changes_found -%}
 8 |   No actionable changes detected.
 9 | {% else -%}
10 |   {% if !directory_changes.changes.is_empty() || directory_changes.base_ref_config_status.is_invalid() -%}
11 |     ### Directory
12 |     {% if directory_changes.base_ref_config_status.is_invalid() %}
13 |       The configuration in the base reference is not valid, so I cannot check what has changed. Please review changes manually.
14 |     {% endif -%}
15 | 
16 |     {% for change in directory_changes.changes %}
17 |       {{~ change.template_format().unwrap() -}}
18 |     {% endfor %}
19 |   {%- endif -%}
20 | 
21 |   {%- for (service_name, service_changes) in services_changes -%}
22 |     {%- if !service_changes.changes.is_empty() || service_changes.base_ref_config_status.is_invalid() ~%}
23 |       ### {{ service_name|capitalize }}
24 | 
25 |       {%- if service_changes.base_ref_config_status.is_invalid() ~%}
26 |         The configuration in the base reference is not valid, so I cannot check what has changed. Please review changes manually.
27 |       {% endif -%}
28 | 
29 |       {%- if !service_changes.changes.is_empty() %}
30 |         {% for change in service_changes.changes %}
31 |           {{~ change.template_format().unwrap() -}}
32 |         {% endfor %}
33 |       {% endif %}
34 |     {%- endif %}
35 |   {%- endfor %}
36 | {% endif -%}
37 | ***
38 | 
39 | 🔸 **Please review the changes detected as they will be applied *immediately* once this PR is merged** 🔸
40 | 


--------------------------------------------------------------------------------
/database/migrations/Dockerfile:
--------------------------------------------------------------------------------
 1 | # Build tern
 2 | FROM golang:1.24.3-alpine3.21 AS tern
 3 | RUN apk --no-cache add git
 4 | RUN go install github.com/jackc/tern@latest
 5 | 
 6 | # Build final image
 7 | FROM alpine:3.21.3
 8 | RUN addgroup -S clowarden && adduser -S clowarden -G clowarden
 9 | USER clowarden
10 | WORKDIR /home/clowarden
11 | COPY --from=tern /go/bin/tern /usr/local/bin
12 | COPY database/migrations .
13 | 


--------------------------------------------------------------------------------
/database/migrations/functions/001_load_functions.sql:
--------------------------------------------------------------------------------
1 | {{ template "changes/search_changes.sql" }}
2 | 
3 | ---- create above / drop below ----
4 | 
5 | -- Nothing to do
6 | 


--------------------------------------------------------------------------------
/database/migrations/functions/changes/search_changes.sql:
--------------------------------------------------------------------------------
  1 | -- Search for changes using the input parameters provided and returns the
  2 | -- results in json format.
  3 | create or replace function search_changes(p_input jsonb)
  4 | returns table(changes json, total_count bigint) as $$
  5 | declare
  6 |     v_limit int := coalesce((p_input->>'limit')::int, 10);
  7 |     v_offset int := coalesce((p_input->>'offset')::int, 0);
  8 |     v_sort_by text := coalesce(p_input->>'sort_by', 'date');
  9 |     v_sort_direction text := coalesce(p_input->>'sort_direction', 'desc');
 10 |     v_organization text := (p_input->>'organization');
 11 |     v_service text[];
 12 |     v_kind text[];
 13 |     v_applied_from timestamptz := (p_input->>'applied_from');
 14 |     v_applied_to timestamptz := (p_input->>'applied_to');
 15 |     v_pr_number bigint[];
 16 |     v_pr_merged_by text[];
 17 |     v_tsquery_web tsquery := websearch_to_tsquery(p_input->>'ts_query_web');
 18 |     v_tsquery_web_with_prefix_matching tsquery;
 19 | begin
 20 |     -- Prepare filters
 21 |     if p_input ? 'service' and p_input->'service' <> 'null' then
 22 |         select array_agg(e::text) into v_service
 23 |         from jsonb_array_elements_text(p_input->'service') e;
 24 |     end if;
 25 |     if p_input ? 'kind' and p_input->'kind' <> 'null' then
 26 |         select array_agg(e::text) into v_kind
 27 |         from jsonb_array_elements_text(p_input->'kind') e;
 28 |     end if;
 29 |     if p_input ? 'pr_number' and p_input->'pr_number' <> 'null' then
 30 |         select array_agg(e::text) into v_pr_number
 31 |         from jsonb_array_elements_text(p_input->'pr_number') e;
 32 |     end if;
 33 |     if p_input ? 'pr_merged_by' and p_input->'pr_merged_by' <> 'null' then
 34 |         select array_agg(e::text) into v_pr_merged_by
 35 |         from jsonb_array_elements_text(p_input->'pr_merged_by') e;
 36 |     end if;
 37 | 
 38 |     -- Prepare v_tsquery_web_with_prefix_matching
 39 |     if v_tsquery_web is not null then
 40 |         select ts_rewrite(
 41 |             v_tsquery_web,
 42 |             format('
 43 |                 select
 44 |                     to_tsquery(lexeme),
 45 |                     to_tsquery(lexeme || '':*'')
 46 |                 from unnest(tsvector_to_array(to_tsvector(%L))) as lexeme
 47 |                 ', p_input->>'ts_query_web'
 48 |             )
 49 |         ) into v_tsquery_web_with_prefix_matching;
 50 |     end if;
 51 | 
 52 |     return query
 53 |     with filtered_changes as (
 54 |         select
 55 |             c.change_id,
 56 |             c.service,
 57 |             c.kind as change_kind,
 58 |             c.extra as change_extra,
 59 |             extract(epoch from c.applied_at) as change_applied_at,
 60 |             c.error as change_error,
 61 |             r.reconciliation_id,
 62 |             r.organization,
 63 |             extract(epoch from r.completed_at) as reconciliation_completed_at,
 64 |             r.error as reconciliation_error,
 65 |             r.pr_number,
 66 |             r.pr_created_by,
 67 |             r.pr_merged_by,
 68 |             extract(epoch from r.pr_merged_at) as pr_merged_at
 69 |         from change c
 70 |         join reconciliation r using (reconciliation_id)
 71 |         where
 72 |             case when v_organization is not null then
 73 |             r.organization = v_organization else true end
 74 |         and
 75 |             case when v_tsquery_web is not null then
 76 |                 v_tsquery_web_with_prefix_matching @@ c.tsdoc
 77 |             else true end
 78 |         and
 79 |             case when cardinality(v_service) > 0 then
 80 |             c.service = any(v_service) else true end
 81 |         and
 82 |             case when cardinality(v_kind) > 0 then
 83 |             c.kind = any(v_kind) else true end
 84 |         and
 85 |             case when v_applied_from is not null then
 86 |             c.applied_at >= v_applied_from else true end
 87 |         and
 88 |             case when v_applied_to is not null then
 89 |             c.applied_at <= v_applied_to else true end
 90 |         and
 91 |             case when cardinality(v_pr_number) > 0 then
 92 |             r.pr_number = any(v_pr_number) else true end
 93 |         and
 94 |             case when cardinality(v_pr_merged_by) > 0 then
 95 |             r.pr_merged_by = any(v_pr_merged_by) else true end
 96 |         and
 97 |             case when p_input ? 'applied_successfully' and (p_input->>'applied_successfully')::boolean = true then
 98 |                 c.error is null
 99 |             else true end
100 |     )
101 |     select
102 |         (
103 |             select coalesce(json_agg(json_strip_nulls(json_build_object(
104 |                 'change_id', change_id,
105 |                 'service', service,
106 |                 'kind', change_kind,
107 |                 'extra', change_extra,
108 |                 'applied_at', change_applied_at,
109 |                 'error', change_error,
110 |                 'reconciliation', json_build_object(
111 |                     'reconciliation_id', reconciliation_id,
112 |                     'organization', organization,
113 |                     'completed_at', reconciliation_completed_at,
114 |                     'error', reconciliation_error,
115 |                     'pr_number', pr_number,
116 |                     'pr_created_by', pr_created_by,
117 |                     'pr_merged_by', pr_merged_by,
118 |                     'pr_merged_at', pr_merged_at
119 |                 )
120 |             ))), '[]')
121 |             from (
122 |                 select *
123 |                 from filtered_changes
124 |                 order by
125 |                     (case when v_sort_by = 'date' and v_sort_direction = 'asc' then change_applied_at end) asc,
126 |                     (case when v_sort_by = 'date' and v_sort_direction = 'desc' then change_applied_at end) desc
127 |                 limit v_limit
128 |                 offset v_offset
129 |             ) fp
130 |         ),
131 |         (
132 |             select count(*) from filtered_changes
133 |         );
134 | end
135 | $$ language plpgsql;
136 | 


--------------------------------------------------------------------------------
/database/migrations/migrate.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | schemaVersionTable=version_schema
 4 | functionsVersionTable=version_functions
 5 | 
 6 | echo "- Applying schema migrations.."
 7 | cd schema
 8 | tern status --config $TERN_CONF --version-table $schemaVersionTable
 9 | tern migrate --config $TERN_CONF --version-table $schemaVersionTable
10 | if [ $? -ne 0 ]; then exit 1; fi
11 | echo "Done"
12 | cd ..
13 | 
14 | echo "- Loading functions.."
15 | cd functions
16 | tern status --config $TERN_CONF --version-table $functionsVersionTable | grep "version:  1 of 1"
17 | if [ $? -eq 0 ]; then
18 |     tern migrate --config $TERN_CONF --version-table $functionsVersionTable --destination -+1
19 | else
20 |     tern migrate --config $TERN_CONF --version-table $functionsVersionTable
21 | fi
22 | if [ $? -ne 0 ]; then exit 1; fi
23 | echo "Done"
24 | 


--------------------------------------------------------------------------------
/database/migrations/schema/001_initial.sql:
--------------------------------------------------------------------------------
 1 | create extension if not exists pgcrypto;
 2 | 
 3 | create table if not exists reconciliation (
 4 |     reconciliation_id uuid primary key default gen_random_uuid(),
 5 |     organization text,
 6 |     completed_at timestamptz default current_timestamp not null,
 7 |     error text,
 8 |     pr_number bigint,
 9 |     pr_created_by text,
10 |     pr_merged_by text,
11 |     pr_merged_at timestamptz
12 | );
13 | 
14 | create table if not exists change (
15 |     change_id uuid primary key default gen_random_uuid(),
16 |     service text not null check (service <> ''),
17 |     kind text not null check (kind <> ''),
18 |     extra jsonb,
19 |     applied_at timestamptz not null,
20 |     error text,
21 |     tsdoc tsvector not null,
22 |     reconciliation_id uuid not null references reconciliation on delete restrict
23 | );
24 | 
25 | create index change_reconciliation_id_idx on change (reconciliation_id);
26 | 


--------------------------------------------------------------------------------
/docs/dev.md:
--------------------------------------------------------------------------------
  1 | # Development environment setup
  2 | 
  3 | This document will help you setup your development environment so that you can build, test and run CLOWarden locally from source.
  4 | 
  5 | The instructions provided in this document rely on a set of [aliases](#aliases) available at the end. These aliases are used by some of the maintainers and are provided only as examples. Please feel free to adapt them to suit your needs. You may want to add them to your shell's configuration file so that they are loaded automatically.
  6 | 
  7 | To start, please clone the [CLOWarden repository](https://github.com/cncf/clowarden). If you plan to use the aliases mentioned above, you should set the `CLOWARDEN_SOURCE` variable to the path where you cloned the repository.
  8 | 
  9 | ## Database
 10 | 
 11 | The datastore used by CLOWarden is PostgreSQL. You can install it locally using your favorite OS package manager.
 12 | 
 13 | Once PostgreSQL is installed and its binaries are available in your `PATH`, we can initialize the database cluster and launch the database server:
 14 | 
 15 | ```sh
 16 | clowarden_db_init
 17 | clowarden_db_server
 18 | ```
 19 | 
 20 | Once the database server is up an running, we can create the `clowarden` database and we'll be ready to go:
 21 | 
 22 | ```sh
 23 | clowarden_db_create
 24 | ```
 25 | 
 26 | ### Migrations
 27 | 
 28 | [Database migrations](https://github.com/cncf/clowarden/tree/main/database/migrations) are managed using [Tern](https://github.com/jackc/tern). Please [install it](https://github.com/jackc/tern#installation) before proceeding. The database schema and functions are managed with migrations.
 29 | 
 30 | We need to create a configuration file so that Tern knows how to connect to our database. We'll create a file called `tern.conf` inside `~/.config/clowarden` with the following content (please adjust as needed):
 31 | 
 32 | ```ini
 33 | [database]
 34 | host = localhost
 35 | port = 5432
 36 | database = clowarden
 37 | user = postgres
 38 | ```
 39 | 
 40 | Now that the `clowarden` database server is up and ready, we just need to apply all available migrations using the following command:
 41 | 
 42 | ```sh
 43 | clowarden_db_migrate
 44 | ```
 45 | 
 46 | ## Backend
 47 | 
 48 | The backend is written in [Rust](https://www.rust-lang.org), and it can be built from the source by using [Cargo](https://rustup.rs), the Rust package manager.
 49 | 
 50 | To build the backend components, please run the command below:
 51 | 
 52 | ```sh
 53 | cargo build
 54 | ```
 55 | 
 56 | Even if you don't plan to do any work on the frontend side of CLOWarden, you may be interested in building it once if you would like to use the CLOWarden web audit tool. To do this, you will have to install [yarn](https://yarnpkg.com/getting-started/install). Once you have it installed, you can build the frontend application by running the following commands:
 57 | 
 58 | ```sh
 59 | cd web && yarn install
 60 | clowarden_frontend_build
 61 | ```
 62 | 
 63 | ### CLOWarden server
 64 | 
 65 | The CLOWarden server is in charge of serving the webhooks endpoints to receive events from external services (i.e. GitHub), as well as the audit tool static assets and the endpoints to power it.
 66 | 
 67 | Once you have a working Rust development environment set up and the audit tool built, it's time to launch the `server`. Before running it, we'll need to create a configuration file in `~/.config/clowarden` named `clowarden.yaml` with the following content (please adjust as needed):
 68 | 
 69 | > [!NOTE]
 70 | > To test CLOWarden locally, you'll need to setup a GitHub application. We recommend creating a new GitHub application for testing purposes. For more details about how to create the application and the permissions needed, please see the chart's [README](https://artifacthub.io/packages/helm/clowarden/clowarden) file. Keep in mind that in the GitHub application settings you'll need to specify the webhook URL, so you'll need to expose your local server to the Internet. You can use a service like Cloudflare's tunnel or Ngrok to achieve this.
 71 | 
 72 | ```yaml
 73 | db:
 74 |   host: localhost
 75 |   port: 5432
 76 |   dbname: clowarden
 77 |   user: postgres
 78 |   password: ""
 79 | 
 80 | server:
 81 |   addr: 0.0.0.0:9000
 82 |   staticPath: /<YOUR_CLOWARDEN_LOCAL_PATH>/web/build
 83 |   githubApp:
 84 |     # Replace with the information from your dev GitHub application
 85 | 
 86 |     # GitHub application ID
 87 |     appId: <YOUR_GITHUB_APP_ID>
 88 | 
 89 |     # GitHub application private key
 90 |     privateKey: |-
 91 |       -----BEGIN RSA PRIVATE KEY-----
 92 |       ...
 93 |       <YOUR_APP_PRIVATE_KEY>
 94 |       ...
 95 |       -----END RSA PRIVATE KEY-----
 96 | 
 97 |     # GitHub application webhook secret
 98 |     webhookSecret: <YOUR_WEBHOOK_SECRET>
 99 | 
100 | services:
101 |   github:
102 |     enabled: true
103 | 
104 | organizations:
105 |   - name: <GITHUB_ORG_TO_MANAGE_WITH_CLOWARDEN>
106 |     installationId: <GITHUB_APP_INSTALLATION_ID>
107 |     repository: <GITHUB_REPO_CONTAINING_CLOWARDEN_CONFIG>
108 |     branch: main
109 |     legacy:
110 |       enabled: true
111 |       sheriffPermissionsPath: config.yaml
112 | ```
113 | 
114 | Now you can run the `server`:
115 | 
116 | ```sh
117 | clowarden_server
118 | ```
119 | 
120 | Once it is up and running, CLOWarden will be ready to process events from GitHub. You can give it a try by creating a new pull request to update the permissions file. If you point your browser to <http://localhost:9000/audit>, you should see the CLOWarden audit tool.
121 | 
122 | ### CLI
123 | 
124 | CLOWarden includes a CLI tool that can be handy when adding new organizations to your CLOWarden deployment.
125 | 
126 | You can use it to:
127 | 
128 | - Validate the configuration in the repository provided
129 | - Display changes between the actual state and the desired state
130 | - Generate a configuration file from the actual state
131 | 
132 | > [!NOTE]
133 | > This tool uses the GitHub API, which requires authentication. Please make sure you provide a GitHub token (with repo and read:org scopes) by setting the GITHUB_TOKEN environment variable.
134 | 
135 | If you are using the aliases provided below, you can run it this way:
136 | 
137 | ```sh
138 | export GITHUB_TOKEN=<your token>
139 | 
140 | clowarden_cli --help
141 | ```
142 | 
143 | ### Backend tests
144 | 
145 | You can run the backend tests by using `cargo` as well. Just run the following command:
146 | 
147 | ```sh
148 | cargo test
149 | ```
150 | 
151 | ## Frontend
152 | 
153 | CLOWarden includes a web based audit tool that allows maintainers to easily search and inspect applied changes. This audit tool is a single page application written in [TypeScript](https://www.typescriptlang.org) using [React](https://reactjs.org).
154 | 
155 | In the backend section we mentioned how to install the frontend dependencies and build it. That should be enough if you are only going to work on the backend. However, if you are planning to do some work on the frontend, it may be better to launch an additional server which will rebuild the web application as needed whenever a file is modified.
156 | 
157 | The frontend development server can be launched using the following command:
158 | 
159 | ```sh
160 | clowarden_frontend_dev
161 | ```
162 | 
163 | That alias will launch an http server that will listen on the port `3000`. Once it's running, you can point your browser to [http://localhost:3000](http://localhost:3000) and you should see the CLOWarden audit tool. The page will be automatically reloaded everytime you make a change in the frontend code. Build errors and build warnings will be visible in the console.
164 | 
165 | API calls will go to <http://localhost:9000>, so the [CLOWarden server](#clowarden-server) is expected to be up and running.
166 | 
167 | ## Aliases
168 | 
169 | The following aliases are used by some of the maintainers and are provided only as examples. Please feel free to adapt them to suit your needs.
170 | 
171 | ```sh
172 | export CLOWARDEN_SOURCE=~/projects/clowarden
173 | export CLOWARDEN_DATA=~/tmp/data_clowarden
174 | 
175 | alias clowarden_db_init="mkdir -p $CLOWARDEN_DATA && initdb -U postgres $CLOWARDEN_DATA"
176 | alias clowarden_db_create="psql -U postgres -c 'create database clowarden'"
177 | alias clowarden_db_drop="psql -U postgres -c 'drop database clowarden with (force)'"
178 | alias clowarden_db_recreate="clowarden_db_drop && clowarden_db_create && clowarden_db_migrate"
179 | alias clowarden_db_server="postgres -D $CLOWARDEN_DATA"
180 | alias clowarden_db_client="psql -h localhost -U postgres clowarden"
181 | alias clowarden_db_migrate="pushd $CLOWARDEN_SOURCE/database/migrations; TERN_CONF=~/.config/clowarden/tern.conf ./migrate.sh; popd"
182 | alias clowarden_server="$CLOWARDEN_SOURCE/target/debug/clowarden-server -c ~/.config/clowarden/clowarden.yaml"
183 | alias clowarden_cli="$CLOWARDEN_SOURCE/target/debug/clowarden-cli"
184 | alias clowarden_frontend_build="pushd $CLOWARDEN_SOURCE/web; yarn build; popd"
185 | alias clowarden_frontend_dev="pushd $CLOWARDEN_SOURCE/web; yarn start; popd"
186 | ```
187 | 


--------------------------------------------------------------------------------
/docs/logo/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/logo/logo.png


--------------------------------------------------------------------------------
/docs/screenshots/audit-tool.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/audit-tool.png


--------------------------------------------------------------------------------
/docs/screenshots/invalid-config-check-run.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/invalid-config-check-run.png


--------------------------------------------------------------------------------
/docs/screenshots/reconciliation-completed-success.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/reconciliation-completed-success.png


--------------------------------------------------------------------------------
/docs/screenshots/valid-config-check-run.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/valid-config-check-run.png


--------------------------------------------------------------------------------
/docs/screenshots/validation-error.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/validation-error.png


--------------------------------------------------------------------------------
/docs/screenshots/validation-succeeded.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/docs/screenshots/validation-succeeded.png


--------------------------------------------------------------------------------
/web/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 |   "trailingComma": "es5",
3 |   "tabWidth": 2,
4 |   "singleQuote": true,
5 |   "printWidth": 120,
6 |   "bracketSpacing": true,
7 |   "arrowParens": "always"
8 | }
9 | 


--------------------------------------------------------------------------------
/web/eslint.config.js:
--------------------------------------------------------------------------------
 1 | // eslint.config.js
 2 | 
 3 | import js from '@eslint/js';
 4 | import reactHooks from 'eslint-plugin-react-hooks';
 5 | import simpleImportSort from 'eslint-plugin-simple-import-sort';
 6 | import tseslint from 'typescript-eslint';
 7 | import globals from "globals";
 8 | 
 9 | const config = [
10 |   js.configs.recommended,
11 |   ...tseslint.configs.recommended,
12 |   {
13 |     linterOptions: {
14 |       reportUnusedDisableDirectives: 'error',
15 |     },
16 |     plugins: {
17 |       '@typescript-eslint': tseslint.plugin,
18 |       'react-hooks': reactHooks,
19 |       'simple-import-sort': simpleImportSort,
20 |     },
21 |     rules: {
22 |       'simple-import-sort/imports': 'error',
23 |       'simple-import-sort/exports': 'error',
24 |     },
25 |     languageOptions: {
26 |       parser: tseslint.parser,
27 |       parserOptions: {
28 |         ecmaVersion: 'latest',
29 |         sourceType: 'module',
30 |       },
31 |       globals: {
32 |         ...globals.browser,
33 |       },
34 |     },
35 |   },
36 | ];
37 | 
38 | export default config;
39 | 


--------------------------------------------------------------------------------
/web/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "clowarden",
 3 |   "version": "0.2.0",
 4 |   "description": "CLOWarden",
 5 |   "license": "Apache-2.0",
 6 |   "type": "module",
 7 |   "dependencies": {
 8 |     "classnames": "^2.5.1",
 9 |     "clo-ui": "https://github.com/cncf/clo-ui.git#v0.4.2",
10 |     "lodash": "^4.17.21",
11 |     "moment": "^2.30.1",
12 |     "react": "^18.3.1",
13 |     "react-dom": "^18.3.1",
14 |     "react-icons": "^5.4.0",
15 |     "react-router-dom": "^7.3.0",
16 |     "source-map-explorer": "^2.5.3"
17 |   },
18 |   "devDependencies": {
19 |     "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
20 |     "@eslint/js": "^9.20.0",
21 |     "@testing-library/jest-dom": "^6.6.3",
22 |     "@testing-library/react": "^16.2.0",
23 |     "@testing-library/user-event": "^14.6.1",
24 |     "@types/jest": "^29.5.14",
25 |     "@types/lodash": "^4.17.15",
26 |     "@types/node": "^22.13.1",
27 |     "@types/react": "^18.3.18",
28 |     "@types/react-dom": "^18.3.5",
29 |     "eslint": "^9.20.0",
30 |     "eslint-config-prettier": "^10.1.1",
31 |     "eslint-plugin-prettier": "^5.2.3",
32 |     "eslint-plugin-react-hooks": "^5.1.0",
33 |     "eslint-plugin-simple-import-sort": "^12.1.1",
34 |     "globals": "^16.0.0",
35 |     "postcss": "^8.5.2",
36 |     "prettier": "^3.5.0",
37 |     "react-scripts": "5.0.1",
38 |     "sass": "^1.84.0",
39 |     "shx": "^0.4.0",
40 |     "typescript": "^5.7.3",
41 |     "typescript-eslint": "^8.24.0"
42 |   },
43 |   "resolutions": {
44 |     "react-scripts/**/core-js-pure": "3.41.0"
45 |   },
46 |   "scripts": {
47 |     "copy:static": "shx rm -rf src/static && shx mkdir src/static && shx cp -r public/static/* src",
48 |     "copy:root-index": "cp build/audit/root_index.html build/index.html && shx rm build/audit/root_index.html",
49 |     "copy:images": "shx mkdir -p build/media && cp -r build/audit/media/*.png build/media",
50 |     "copy:manifest": "mv build/audit/manifest.json build",
51 |     "analyze": "source-map-explorer 'build/static/js/*.js'",
52 |     "start": "yarn copy:static && DANGEROUSLY_DISABLE_HOST_CHECK=true DISABLE_ESLINT_PLUGIN=true react-scripts start",
53 |     "build": "yarn copy:static && BUILD_PATH=./build/audit PUBLIC_URL=/audit INLINE_RUNTIME_CHUNK=false DISABLE_ESLINT_PLUGIN=true IMAGE_INLINE_SIZE_LIMIT=0 react-scripts build && shx cp -r build/audit/static/* build/audit && shx rm -rf build/audit/static && yarn copy:root-index && yarn copy:images && yarn copy:manifest",
54 |     "test": "react-scripts test",
55 |     "eject": "react-scripts eject",
56 |     "lint": "eslint src --max-warnings 0",
57 |     "lint:fix": "eslint src --max-warnings 0 --fix",
58 |     "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,scss,md}\"",
59 |     "format:diff": "prettier --list-different \"src/**/*.{js,jsx,ts,tsx,json,css,scss,md}\""
60 |   },
61 |   "proxy": "http://127.0.0.1:9000",
62 |   "jest": {
63 |     "moduleNameMapper": {
64 |       "\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/__mocks__/fileMock.js",
65 |       "\\.(css|less)$": "<rootDir>/__mocks__/fileMock.js"
66 |     }
67 |   },
68 |   "browserslist": {
69 |     "production": [
70 |       ">0.2%",
71 |       "not dead",
72 |       "not op_mini all"
73 |     ],
74 |     "development": [
75 |       "last 1 chrome version",
76 |       "last 1 firefox version",
77 |       "last 1 safari version"
78 |     ]
79 |   }
80 | }
81 | 


--------------------------------------------------------------------------------
/web/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en" data-theme="light">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="shortcut icon" type="image/png" href="https://clowarden.io/static/media/logo.png" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
 7 |     <meta name="theme-color" content="#2a0552" />
 8 |     <meta name="description" content="CLOWarden" />
 9 |     <link rel="apple-touch-icon" href="https://clowarden.io/static/media/logo192.png" />
10 |     <link rel="apple-touch-icon" sizes="512x512" href="https://clowarden.io/static/media/logo512.png" />
11 |     <link rel="manifest" href="/static/manifest.json" />
12 |     <title>CLOWarden</title>
13 |     <meta property="og:type" content="website" />
14 |     <meta property="og:title" content="CLOWarden" />
15 |     <meta property="og:description" content="CLOWarden" />
16 |     <meta property="og:image" content="https://clowarden.io/static/media/clowarden.png" />
17 |     <meta name="twitter:card" content="summary_large_image" />
18 |     <meta name="twitter:title" content="CLOWarden" />
19 |     <meta name="twitter:description" content="CLOWarden" />
20 |     <meta name="twitter:image:src" content="https://clowarden.io/static/media/clowarden.png" />
21 |   </head>
22 |   <body>
23 |     <noscript>You need to enable JavaScript to run this app.</noscript>
24 |     <div id="clo-wrapper"></div>
25 |   </body>
26 | </html>
27 | 


--------------------------------------------------------------------------------
/web/public/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "short_name": "CLOWarden",
 3 |   "name": "CLOWarden",
 4 |   "icons": [
 5 |     {
 6 |       "src": "/static/media/logo.png",
 7 |       "sizes": "64x64 32x32 24x24 16x16",
 8 |       "type": "image/x-icon"
 9 |     },
10 |     {
11 |       "src": "/static/media/logo192.png",
12 |       "type": "image/png",
13 |       "sizes": "192x192"
14 |     },
15 |     {
16 |       "src": "/static/media/logo512.png",
17 |       "type": "image/png",
18 |       "sizes": "512x512"
19 |     }
20 |   ],
21 |   "start_url": ".",
22 |   "display": "standalone",
23 |   "theme_color": "#000000",
24 |   "background_color": "#ffffff"
25 | }
26 | 


--------------------------------------------------------------------------------
/web/public/static/media/clowarden.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/web/public/static/media/clowarden.png


--------------------------------------------------------------------------------
/web/public/static/media/clowarden.svg:
--------------------------------------------------------------------------------
 1 | <?xml version='1.0' encoding='utf-8'?>
 2 | <!-- Generator: imaengine 6.0   -->
 3 | <svg xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" viewBox="0,0,562,75" style="enable-background:new 0 0 562 75;" version="1.1">
 4 | <defs/>
 5 | <g id="layer0">
 6 | <g>
 7 | <path d="M118.899,52.2633C124.39,52.2633 128.717,50.1 132.211,45.7734L139.367,53.0954C133.709,59.4189 127.219,62.5807 119.564,62.5807C111.91,62.5807 105.752,60.2509 100.76,55.4251C95.7679,50.5992 93.4382,44.6085 93.4382,37.2866C93.4382,29.9646 95.9343,23.8074 100.927,18.9816C105.919,14.1557 112.076,11.6596 119.398,11.6596C127.552,11.6596 134.375,14.8214 139.7,20.9785L132.877,28.7997C129.382,24.4731 125.056,22.3098 119.897,22.3098C115.737,22.3098 112.242,23.641 109.247,26.3036C106.252,28.9661 104.754,32.6271 104.754,37.2866C104.754,41.946 106.085,45.607 108.914,48.4359C111.577,50.7656 114.905,52.2633 118.899,52.2633L118.899,52.2633L118.899,52.2633L118.899,52.2633L118.899,52.2633Z" fill="#FFFFFF"/>
 8 | <path d="M148.02,61.915L148.02,12.4917L159.003,12.4917L159.003,52.0969L180.137,52.0969L180.137,61.915L148.02,61.915L148.02,61.915L148.02,61.915L148.02,61.915L148.02,61.915Z" fill="#FFFFFF"/>
 9 | <path d="M228.396,55.0923C223.403,59.9181 217.246,62.4143 209.924,62.4143C202.602,62.4143 196.445,59.9181 191.453,55.0923C186.461,50.2664 183.965,44.1093 183.965,36.9537C183.965,29.6318 186.461,23.641 191.453,18.8152C196.445,13.9893 202.602,11.4932 209.924,11.4932C217.246,11.4932 223.403,13.9893 228.396,18.8152C233.388,23.641 235.884,29.7982 235.884,36.9537C235.884,44.2757 233.388,50.2664 228.396,55.0923L228.396,55.0923L228.396,55.0923L228.396,55.0923L228.396,55.0923ZM224.568,36.9537C224.568,32.6271 223.071,28.7997 220.242,25.6379C217.413,22.4762 213.918,20.9785 209.758,20.9785C205.598,20.9785 202.103,22.4762 199.274,25.6379C196.445,28.7997 194.947,32.4607 194.947,36.9537C194.947,41.2804 196.445,45.1078 199.274,48.2695C202.103,51.4313 205.598,52.929 209.758,52.929C213.918,52.929 217.413,51.4313 220.242,48.2695C223.237,45.1078 224.568,41.4468 224.568,36.9537L224.568,36.9537L224.568,36.9537L224.568,36.9537L224.568,36.9537Z" fill="#FFFFFF"/>
10 | </g>
11 | </g>
12 | <g id="layer1">
13 | <g>
14 | <path d="M15.5,47.7L6.4,47.7L6.4,69.1L27.7,69.1L27.7,59.9L15.5,59.9L15.5,47.7L15.5,47.7L15.5,47.7L15.5,47.7Z" fill="#FFFFFF"/>
15 | <path d="M61.3,47.8L61.3,59.9L49.1,59.9L49.1,59.8L49.1,69.1L70.4,69.1L70.4,47.7L61.2,47.7L61.3,47.8L61.3,47.8L61.3,47.8L61.3,47.8Z" fill="#FFFFFF"/>
16 | <path d="M6.4,26.4L15.6,26.4L15.5,26.3L15.5,14.2L27.7,14.2L27.7,5L6.4,5L6.4,26.4L6.4,26.4L6.4,26.4L6.4,26.4Z" fill="#FFFFFF"/>
17 | <path d="M49.1,5L49.1,14.2L61.3,14.2L61.3,26.4L70.4,26.4L70.4,5L49.1,5L49.1,5L49.1,5L49.1,5Z" fill="#FFFFFF"/>
18 | </g>
19 | <g>
20 | <path d="M35.7,14.2L49.1,14.2L49.1,5L27.7,5L27.7,14.2L35.7,14.2L35.7,14.2L35.7,14.2Z" fill="#FFFFFF" fill-opacity="0.5"/>
21 | <path d="M41,59.9L27.7,59.9L27.7,69.1L49.1,69.1L49.1,59.8L41,59.9L41,59.9L41,59.9Z" fill="#FFFFFF" fill-opacity="0.5"/>
22 | <path d="M61.3,26.4L61.3,39.7L61.2,47.7L70.4,47.7L70.4,26.4L61.3,26.4L61.3,26.4L61.3,26.4L61.3,26.4Z" fill="#FFFFFF" fill-opacity="0.5"/>
23 | <path d="M15.6,26.4L6.4,26.4L6.4,47.7L15.5,47.7L15.5,34.4L15.6,26.4L15.6,26.4L15.6,26.4Z" fill="#FFFFFF" fill-opacity="0.7"/>
24 | </g>
25 | <g>
26 | <path d="M15.6356,47.7702L6.53564,47.7702L6.53564,69.1702L27.8356,69.1702L27.8356,59.9702L15.6356,59.9702L15.6356,47.7702L15.6356,47.7702L15.6356,47.7702L15.6356,47.7702Z" fill="#FFFFFF"/>
27 | <path d="M61.4356,47.8702L61.4356,59.9702L49.2356,59.9702L49.2356,59.8702L49.2356,69.1702L70.5356,69.1702L70.5356,47.7702L61.3356,47.7702L61.4356,47.8702L61.4356,47.8702L61.4356,47.8702L61.4356,47.8702Z" fill="#FFFFFF"/>
28 | <path d="M6.53564,26.4702L15.7356,26.4702L15.6356,26.3702L15.6356,14.2702L27.8356,14.2702L27.8356,5.07022L6.53564,5.07022L6.53564,26.4702L6.53564,26.4702L6.53564,26.4702L6.53564,26.4702Z" fill="#FFFFFF"/>
29 | <path d="M49.2356,5.07022L49.2356,14.2702L61.4356,14.2702L61.4356,26.4702L70.5356,26.4702L70.5356,5.07022L49.2356,5.07022L49.2356,5.07022L49.2356,5.07022L49.2356,5.07022Z" fill="#FFFFFF"/>
30 | </g>
31 | <g>
32 | <path d="M35.8356,14.2702L49.2356,14.2702L49.2356,5.07022L27.8356,5.07022L27.8356,14.2702L35.8356,14.2702L35.8356,14.2702L35.8356,14.2702Z" fill="#FFFFFF" fill-opacity="0.5"/>
33 | <path d="M41.1356,59.9702L27.8356,59.9702L27.8356,69.1702L49.2356,69.1702L49.2356,59.8702L41.1356,59.9702L41.1356,59.9702L41.1356,59.9702Z" fill="#FFFFFF" fill-opacity="0.5"/>
34 | <path d="M61.4356,26.4702L61.4356,39.7702L61.3356,47.7702L70.5356,47.7702L70.5356,26.4702L61.4356,26.4702L61.4356,26.4702L61.4356,26.4702L61.4356,26.4702Z" fill="#FFFFFF" fill-opacity="0.5"/>
35 | <path d="M15.7356,26.4702L6.53564,26.4702L6.53564,47.7702L15.6356,47.7702L15.6356,34.4702L15.7356,26.4702L15.7356,26.4702L15.7356,26.4702Z" fill="#FFFFFF" fill-opacity="0.7"/>
36 | </g>
37 | <path d="M37.023,18.0972C35.7503,18.8723 34.2151,19.1095 33.3936,19.1095C32.5716,19.1095 31.438,19.0935 29.7821,18.1375C29.0956,17.7411 28.9718,17.6684 28.6032,17.6684C27.5421,17.6684 22.7363,22.4653 22.6569,23.1192C22.5775,23.7732 25.2963,25.4335 25.4272,27.8155C25.558,30.1974 23.8508,32.8943 23.1464,34.9971C21.6865,39.3482 21.2908,39.8411 21.2908,42.0524C21.6126,48.4332 25.9425,52.8734 32.0485,53.9058C34.6654,54.3028 35.7359,54.6835 36.9059,55.6334C37.3936,55.9907 37.9313,56.5118 38.5283,56.58L38.5283,56.5823C38.5308,56.5821 38.5332,56.5815 38.5356,56.5811C38.5381,56.5814 38.5405,56.5821 38.5429,56.5823L38.5429,56.58C39.14,56.5118 39.6777,55.9907 40.1654,55.6334C41.3354,54.6835 42.4059,54.3028 45.0228,53.9058C51.1287,52.8734 55.4586,48.4332 55.7805,42.0524C55.7805,39.8411 55.3848,39.3482 53.9249,34.9971C53.2205,32.8943 51.5133,30.1974 51.6441,27.8155C51.7749,25.4335 54.4938,23.7732 54.4144,23.1192C54.3349,22.4653 49.5292,17.6684 48.4681,17.6684C48.0995,17.6684 47.9757,17.7411 47.2892,18.1375C45.6333,19.0935 44.4997,19.1095 43.6777,19.1095C42.8562,19.1095 41.321,18.8723 40.0483,18.0972C39.6761,17.8716 39.2241,17.6581 38.5356,17.6581C37.9932,17.6581 37.4389,17.8466 37.0229,18.0972L37.023,18.0972L37.023,18.0972Z" fill="#FFFFFF"/>
38 | </g>
39 | <g id="layer2">
40 | <g>
41 | <path d="M258.334,63.5222L244.631,11.8754L251.641,11.8754L259.497,45.7312C260.343,49.2776 261.071,52.8006 261.681,56.3C262.996,50.7808 263.772,47.5983 264.007,46.7528L273.836,11.8754L282.079,11.8754L289.478,38.0159C291.334,44.4981 292.672,50.5928 293.495,56.3C294.151,53.0355 295.008,49.2894 296.065,45.0617L304.168,11.8754L311.038,11.8754L296.876,63.5222L290.289,63.5222L279.402,24.1705C278.486,20.8824 277.946,18.8625 277.781,18.111C277.241,20.4832 276.736,22.503 276.266,24.1705L265.31,63.5222L258.334,63.5222L258.334,63.5222L258.334,63.5222Z" fill="#FFFFFF" fill-opacity="0.7"/>
42 | <path d="M309.066,63.5222L328.9,11.8754L336.263,11.8754L357.401,63.5222L349.614,63.5222L343.591,47.8802L321.995,47.8802L316.323,63.5222L309.066,63.5222L309.066,63.5222L309.066,63.5222ZM323.967,42.3139L341.477,42.3139L336.086,28.0105C334.442,23.6656 333.222,20.0956 332.423,17.3007C331.766,20.6123 330.837,23.9005 329.64,27.165L323.967,42.3139L323.967,42.3139L323.967,42.3139Z" fill="#FFFFFF" fill-opacity="0.7"/>
43 | <path d="M362.967,63.5222L362.967,11.8754L385.867,11.8754C390.47,11.8754 393.969,12.3392 396.364,13.2669C398.761,14.1946 400.674,15.8328 402.108,18.1814C403.54,20.5301 404.257,23.1253 404.257,25.9672C404.257,29.6311 403.071,32.7197 400.698,35.2327C398.326,37.7458 394.662,39.3428 389.706,40.0239C391.515,40.8929 392.889,41.7502 393.828,42.5958C395.825,44.4277 397.715,46.7176 399.501,49.4655L408.485,63.5222L399.888,63.5222L393.054,52.7772C391.057,49.6769 389.413,47.3048 388.121,45.6607C386.83,44.0166 385.673,42.8658 384.651,42.2082C383.63,41.5505 382.59,41.0926 381.533,40.8342C380.758,40.6698 379.49,40.5876 377.728,40.5876L369.802,40.5876L369.802,63.5222L362.967,63.5222L362.967,63.5222L362.967,63.5222ZM369.802,34.6691L384.492,34.6691C387.616,34.6691 390.058,34.3461 391.82,33.7002C393.582,33.0543 394.92,32.0209 395.837,30.6C396.753,29.179 397.211,27.6347 397.211,25.9672C397.211,23.5247 396.324,21.5166 394.551,19.943C392.777,18.3694 389.977,17.5826 386.148,17.5826L369.802,17.5826L369.802,34.6691L369.802,34.6691L369.802,34.6691Z" fill="#FFFFFF" fill-opacity="0.7"/>
44 | <path d="M414.966,63.5222L414.966,11.8754L432.757,11.8754C436.774,11.8754 439.839,12.122 441.953,12.6151C444.912,13.2962 447.436,14.5293 449.526,16.3143C452.251,18.6159 454.288,21.5576 455.639,25.1394C456.989,28.7211 457.665,32.8136 457.665,37.4169C457.665,41.3391 457.207,44.8152 456.29,47.8449C455.375,50.8747 454.2,53.3819 452.768,55.3665C451.335,57.3512 449.768,58.913 448.065,60.0521C446.362,61.1911 444.307,62.0543 441.9,62.6415C439.492,63.2287 436.727,63.5222 433.603,63.5222L414.966,63.5222L414.966,63.5222L414.966,63.5222ZM421.801,57.4274L432.828,57.4274C436.234,57.4274 438.904,57.1104 440.843,56.4762C442.78,55.8421 444.324,54.9496 445.475,53.7988C447.096,52.1782 448.359,49.9998 449.263,47.2637C450.167,44.5275 450.619,41.21 450.619,37.3112C450.619,31.9093 449.732,27.7581 447.959,24.8575C446.186,21.957 444.031,20.0135 441.495,19.0269C439.662,18.3224 436.715,17.97 432.651,17.97L421.801,17.97L421.801,57.4274L421.801,57.4274L421.801,57.4274Z" fill="#FFFFFF" fill-opacity="0.7"/>
45 | <path d="M467.212,63.5222L467.212,11.8754L504.555,11.8754L504.555,17.97L474.047,17.97L474.047,33.7882L502.618,33.7882L502.618,39.8478L474.047,39.8478L474.047,57.4274L505.753,57.4274L505.753,63.5222L467.212,63.5222L467.212,63.5222L467.212,63.5222Z" fill="#FFFFFF" fill-opacity="0.7"/>
46 | <path d="M515.124,63.5222L515.124,11.8754L522.135,11.8754L549.262,52.4248L549.262,11.8754L555.815,11.8754L555.815,63.5222L548.804,63.5222L521.677,22.9375L521.677,63.5222L515.124,63.5222L515.124,63.5222L515.124,63.5222Z" fill="#FFFFFF" fill-opacity="0.7"/>
47 | </g>
48 | </g>
49 | </svg>
50 | 


--------------------------------------------------------------------------------
/web/public/static/media/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/web/public/static/media/logo.png


--------------------------------------------------------------------------------
/web/public/static/media/logo192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/web/public/static/media/logo192.png


--------------------------------------------------------------------------------
/web/public/static/media/logo512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cncf/clowarden/e76daceba7f571b589cc5bfe3647ae26408cc8cf/web/public/static/media/logo512.png


--------------------------------------------------------------------------------
/web/src/App.module.css:
--------------------------------------------------------------------------------
1 | :global(.form-select),
2 | :global(.input-group-sm .form-control) {
3 |   font-size: 0.8rem;
4 | }
5 | 


--------------------------------------------------------------------------------
/web/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import 'clo-ui/dist/styles/default.scss';
 2 | import './App.module.css';
 3 | 
 4 | import { BrowserRouter as Router, Navigate, Route, Routes } from 'react-router-dom';
 5 | 
 6 | import { AppContextProvider } from './context/AppContextProvider';
 7 | import Layout from './layout';
 8 | import Audit from './layout/audit';
 9 | import NotFound from './layout/notFound';
10 | 
11 | function App() {
12 |   return (
13 |     <AppContextProvider>
14 |       <Router>
15 |         <Routes>
16 |           <Route path="/" element={<Layout />}>
17 |             <Route index element={<Navigate to="/audit" replace />} />
18 |             <Route path="/audit" element={<Audit />} />
19 |             <Route path="*" element={<NotFound />} />
20 |           </Route>
21 |         </Routes>
22 |       </Router>
23 |     </AppContextProvider>
24 |   );
25 | }
26 | 
27 | export default App;
28 | 


--------------------------------------------------------------------------------
/web/src/api/index.ts:
--------------------------------------------------------------------------------
  1 | import { isEmpty, isNull, isUndefined } from 'lodash';
  2 | import isArray from 'lodash/isArray';
  3 | 
  4 | import { DEFAULT_SORT_BY, DEFAULT_SORT_DIRECTION, DEFAULT_TIME_RANGE } from '../data';
  5 | import { Change, Error, ErrorKind, SearchQuery } from '../types';
  6 | import calculateTimeRange from '../utils/calculateTimeRange';
  7 | 
  8 | interface FetchOptions {
  9 |   method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'HEAD';
 10 |   headers?: {
 11 |     [key: string]: string;
 12 |   };
 13 |   body?: string;
 14 | }
 15 | 
 16 | interface APIFetchProps {
 17 |   url: string;
 18 |   opts?: FetchOptions;
 19 |   headers?: string[];
 20 | }
 21 | 
 22 | class API_CLASS {
 23 |   private API_BASE_URL = '/audit/api';
 24 |   private HEADERS = {
 25 |     pagination: 'Pagination-Total-Count',
 26 |   };
 27 | 
 28 |   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 29 |   private getHeadersValue(res: any, params?: string[]): any {
 30 |     if (!isUndefined(params) && params.length > 0) {
 31 |       // eslint-disable-next-line @typescript-eslint/no-explicit-any
 32 |       const headers: any = {};
 33 |       params.forEach((param: string) => {
 34 |         if (res.headers.has(param)) {
 35 |           headers[param] = res.headers.get(param);
 36 |         }
 37 |       });
 38 |       return headers;
 39 |     }
 40 |     return null;
 41 |   }
 42 | 
 43 |   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 44 |   private async processFetchOptions(opts?: FetchOptions): Promise<FetchOptions | any> {
 45 |     // eslint-disable-next-line @typescript-eslint/no-explicit-any
 46 |     const options: FetchOptions | any = opts || {};
 47 |     if (opts && ['DELETE', 'POST', 'PUT'].includes(opts.method)) {
 48 |       return {
 49 |         ...options,
 50 |         headers: {
 51 |           ...options.headers,
 52 |         },
 53 |       };
 54 |     }
 55 |     return options;
 56 |   }
 57 | 
 58 |   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 59 |   private async handleErrors(res: any) {
 60 |     if (!res.ok) {
 61 |       let error: Error;
 62 |       switch (res.status) {
 63 |         default:
 64 |           try {
 65 |             const text = await res.json();
 66 |             error = {
 67 |               kind: ErrorKind.Other,
 68 |               message: text.message !== '' ? text.message : undefined,
 69 |             };
 70 |           } catch {
 71 |             error = {
 72 |               kind: ErrorKind.Other,
 73 |             };
 74 |           }
 75 |       }
 76 |       throw error;
 77 |     }
 78 |     return res;
 79 |   }
 80 | 
 81 |   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 82 |   private async handleContent(res: any, headers?: string[]) {
 83 |     const response = res;
 84 |     let content;
 85 |     let tmpHeaders;
 86 | 
 87 |     switch (response.headers.get('Content-Type')) {
 88 |       case 'text/plain; charset=utf-8':
 89 |       case 'csv':
 90 |         content = await response.text();
 91 |         return content;
 92 |       case 'application/json':
 93 |         content = await response.json();
 94 |         tmpHeaders = this.getHeadersValue(res, headers);
 95 |         if (!isNull(tmpHeaders)) {
 96 |           if (isArray(content)) {
 97 |             content = { items: content };
 98 |           }
 99 |           content = { ...content, ...tmpHeaders };
100 |         }
101 |         return content;
102 |       default:
103 |         return response;
104 |     }
105 |   }
106 | 
107 |   private async apiFetch(props: APIFetchProps) {
108 |     // eslint-disable-next-line @typescript-eslint/no-explicit-any
109 |     const options: FetchOptions | any = await this.processFetchOptions(props.opts);
110 | 
111 |     return fetch(props.url, options)
112 |       .then(this.handleErrors)
113 |       .then((res) => this.handleContent(res, props.headers))
114 |       .catch((error) => Promise.reject(error));
115 |   }
116 | 
117 |   public getOrganizations(): Promise<string[]> {
118 |     return this.apiFetch({
119 |       url: `${this.API_BASE_URL}/organizations`,
120 |     });
121 |   }
122 | 
123 |   public searchChangesInput(query: SearchQuery): Promise<{ items: Change[]; 'Pagination-Total-Count': string }> {
124 |     let q: string = `limit=${query.limit}&offset=${query.offset}&sort_by=${
125 |       query.sort_by || DEFAULT_SORT_BY
126 |     }&sort_direction=${query.sort_direction || DEFAULT_SORT_DIRECTION}`;
127 | 
128 |     const timeRange = calculateTimeRange(query.time_range || DEFAULT_TIME_RANGE);
129 |     q += `&applied_from=${encodeURIComponent(timeRange.from)}&applied_to=${encodeURIComponent(timeRange.to)}`;
130 | 
131 |     if (query.organization) {
132 |       q += `&organization=${query.organization}`;
133 |     }
134 | 
135 |     if (query.ts_query_web) {
136 |       q += `&ts_query_web=${query.ts_query_web}`;
137 |     }
138 | 
139 |     if (!isUndefined(query.filters) && !isEmpty(query.filters)) {
140 |       Object.keys(query.filters!).forEach((k: string) => {
141 |         query.filters![k].forEach((f: string, index: number) => {
142 |           q += `&${k}[${index}]=${f}`;
143 |         });
144 |       });
145 |     }
146 |     return this.apiFetch({
147 |       url: `${this.API_BASE_URL}/changes/search?${q}`,
148 |       headers: [this.HEADERS.pagination],
149 |       opts: {
150 |         method: 'GET',
151 |         headers: {
152 |           'Content-Type': 'application/json',
153 |         },
154 |       },
155 |     });
156 |   }
157 | }
158 | 
159 | const API = new API_CLASS();
160 | export default API;
161 | 


--------------------------------------------------------------------------------
/web/src/context/AppContextProvider.tsx:
--------------------------------------------------------------------------------
  1 | import { detectActiveThemeMode, useSystemThemeMode } from 'clo-ui';
  2 | import { isNull } from 'lodash';
  3 | import { createContext, Dispatch, useContext, useEffect, useReducer, useState } from 'react';
  4 | 
  5 | import { Prefs, SortBy, SortDirection } from '../types';
  6 | import lsStorage from '../utils/localStoragePreferences';
  7 | 
  8 | interface AppState {
  9 |   prefs: Prefs;
 10 | }
 11 | 
 12 | interface Props {
 13 |   children: JSX.Element;
 14 | }
 15 | 
 16 | const initialState: AppState = {
 17 |   prefs: lsStorage.getPrefs(),
 18 | };
 19 | 
 20 | type Action =
 21 |   | { type: 'updateTheme'; theme: string }
 22 |   | { type: 'updateEffectiveTheme'; theme: string }
 23 |   | { type: 'updateSort'; by: SortBy; direction: SortDirection };
 24 | export const AppContext = createContext<{
 25 |   ctx: AppState;
 26 |   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 27 |   dispatch: Dispatch<any>;
 28 | }>({
 29 |   ctx: initialState,
 30 |   dispatch: () => null,
 31 | });
 32 | 
 33 | export function updateTheme(theme: string) {
 34 |   return { type: 'updateTheme', theme };
 35 | }
 36 | 
 37 | export function updateEffectiveTheme(theme: string) {
 38 |   return { type: 'updateTheme', theme };
 39 | }
 40 | 
 41 | export function updateSort(by: SortBy, direction: SortDirection) {
 42 |   return { type: 'updateSort', by, direction };
 43 | }
 44 | 
 45 | export function updateActiveStyleSheet(current: string) {
 46 |   document.getElementsByTagName('html')[0].setAttribute('data-theme', current);
 47 |   document
 48 |     .querySelector(`meta[name='theme-color']`)!
 49 |     .setAttribute('content', current === 'light' ? '#2a0552' : '#0f0e11');
 50 | }
 51 | 
 52 | export function appReducer(state: AppState, action: Action) {
 53 |   let prefs;
 54 |   let effective;
 55 |   switch (action.type) {
 56 |     case 'updateTheme':
 57 |       effective = action.theme === 'automatic' ? detectActiveThemeMode() : action.theme;
 58 |       prefs = {
 59 |         ...state.prefs,
 60 |         theme: {
 61 |           configured: action.theme,
 62 |           effective: effective,
 63 |         },
 64 |       };
 65 | 
 66 |       lsStorage.setPrefs(prefs);
 67 |       updateActiveStyleSheet(effective);
 68 |       return {
 69 |         ...state,
 70 |         prefs: prefs,
 71 |       };
 72 | 
 73 |     case 'updateEffectiveTheme':
 74 |       prefs = {
 75 |         ...state.prefs,
 76 |         theme: {
 77 |           ...state.prefs.theme,
 78 |           effective: action.theme,
 79 |         },
 80 |       };
 81 |       lsStorage.setPrefs(prefs);
 82 |       updateActiveStyleSheet(action.theme);
 83 |       return {
 84 |         ...state,
 85 |         prefs: prefs,
 86 |       };
 87 | 
 88 |     case 'updateSort':
 89 |       prefs = {
 90 |         ...state.prefs,
 91 |         search: {
 92 |           ...state.prefs.search,
 93 |           sort: {
 94 |             by: action.by,
 95 |             direction: action.direction,
 96 |           },
 97 |         },
 98 |       };
 99 |       lsStorage.setPrefs(prefs);
100 |       return {
101 |         ...state,
102 |         prefs: prefs,
103 |       };
104 | 
105 |     default:
106 |       return { ...state };
107 |   }
108 | }
109 | 
110 | function AppContextProvider(props: Props) {
111 |   const activeProfilePrefs = lsStorage.getPrefs();
112 |   const [ctx, dispatch] = useReducer(appReducer, {
113 |     prefs: activeProfilePrefs,
114 |   });
115 |   const [activeInitialTheme, setActiveInitialTheme] = useState<string | null>(null);
116 | 
117 |   useEffect(() => {
118 |     const theme =
119 |       activeProfilePrefs.theme.configured === 'automatic'
120 |         ? detectActiveThemeMode()
121 |         : activeProfilePrefs.theme.configured || activeProfilePrefs.theme.effective; // Use effective theme if configured is undefined
122 |     updateActiveStyleSheet(theme);
123 |     setActiveInitialTheme(theme);
124 |   }, []);
125 | 
126 |   useSystemThemeMode(ctx.prefs.theme.configured === 'automatic', dispatch);
127 | 
128 |   if (isNull(activeInitialTheme)) return null;
129 | 
130 |   return <AppContext.Provider value={{ ctx, dispatch }}>{props.children}</AppContext.Provider>;
131 | }
132 | 
133 | function useAppContext() {
134 |   return useContext(AppContext);
135 | }
136 | 
137 | export { AppContextProvider, useAppContext };
138 | 


--------------------------------------------------------------------------------
/web/src/data.tsx:
--------------------------------------------------------------------------------
  1 | import { FilterSection } from 'clo-ui';
  2 | 
  3 | import { ChangeKind, FilterKind, Option, SearchTipItem, Service, SortBy, SortDirection, SortOption } from './types';
  4 | 
  5 | export const DEFAULT_SORT_BY = SortBy.Date;
  6 | export const DEFAULT_SORT_DIRECTION = SortDirection.DESC;
  7 | export const DEFAULT_TIME_RANGE = '1M';
  8 | export const PAGINATION_LIMIT = 50;
  9 | 
 10 | export const SORT_OPTIONS: SortOption[] = [
 11 |   {
 12 |     label: 'Applied at (asc)',
 13 |     by: SortBy.Date,
 14 |     direction: SortDirection.ASC,
 15 |   },
 16 |   {
 17 |     label: 'Applied at (desc)',
 18 |     by: SortBy.Date,
 19 |     direction: SortDirection.DESC,
 20 |   },
 21 | ];
 22 | 
 23 | export const FILTER_CATEGORY_NAMES = {
 24 |   [FilterKind.Service]: 'Service',
 25 |   [FilterKind.Kind]: 'Change',
 26 |   [FilterKind.PRNumber]: 'PR number',
 27 |   [FilterKind.PRMergedBy]: 'PR merged by',
 28 |   [FilterKind.AppliedSuccessfully]: 'Status',
 29 | };
 30 | 
 31 | export const FILTERS: FilterSection[] = [
 32 |   {
 33 |     key: FilterKind.Service,
 34 |     title: 'Services',
 35 |     options: [{ value: Service.GitHub, name: 'GitHub' }],
 36 |   },
 37 |   {
 38 |     key: FilterKind.Kind,
 39 |     title: 'Changes',
 40 |     options: {
 41 |       team: [
 42 |         { value: ChangeKind.TeamAdded, name: 'Added' },
 43 |         { value: ChangeKind.TeamRemoved, name: 'Removed' },
 44 |         { value: ChangeKind.TeamMaintainerAdded, name: 'Maintainer added' },
 45 |         { value: ChangeKind.TeamMaintainerRemoved, name: 'Maintainer removed' },
 46 |         { value: ChangeKind.TeamMemberAdded, name: 'Member added' },
 47 |         { value: ChangeKind.TeamMemberRemoved, name: 'Member removed' },
 48 |       ],
 49 |       repository: [
 50 |         { value: ChangeKind.RepositoryAdded, name: 'Added' },
 51 |         { value: ChangeKind.RepositoryTeamAdded, name: 'Team added' },
 52 |         { value: ChangeKind.RepositoryTeamRemoved, name: 'Team removed' },
 53 |         { value: ChangeKind.RepositoryTeamRoleUpdated, name: 'Team role updated' },
 54 |         { value: ChangeKind.RepositoryCollaboratorAdded, name: 'Collaborator added' },
 55 |         { value: ChangeKind.RepositoryCollaboratorRemoved, name: 'Collaborator removed' },
 56 |         { value: ChangeKind.RepositoryCollaboratorRoleUpdated, name: 'Collaborator role updated' },
 57 |         { value: ChangeKind.RepositoryVisibilityUpdated, name: 'Visibility updated' },
 58 |       ],
 59 |     },
 60 |   },
 61 | ];
 62 | 
 63 | export const SEARCHABLE_FILTERS: FilterSection[] = [
 64 |   {
 65 |     key: FilterKind.PRNumber,
 66 |     placeholder: 'Add PR number',
 67 |     title: 'PR number',
 68 |     options: [],
 69 |   },
 70 |   {
 71 |     key: FilterKind.PRMergedBy,
 72 |     placeholder: 'Add GitHub handle',
 73 |     title: 'PR merged by',
 74 |     options: [],
 75 |   },
 76 | ];
 77 | 
 78 | export const SEARCH_TIPS: SearchTipItem[] = [
 79 |   {
 80 |     content: (
 81 |       <>
 82 |         Use <span className="fw-semibold">multiple words</span> to refine your search.
 83 |       </>
 84 |     ),
 85 |     example: 'team1 repo1',
 86 |   },
 87 | ];
 88 | 
 89 | export const DATE_RANGE: Option[] = [
 90 |   {
 91 |     label: 'Last hour',
 92 |     value: '1h',
 93 |   },
 94 |   {
 95 |     label: 'Last 6 hours',
 96 |     value: '6h',
 97 |   },
 98 |   {
 99 |     label: 'Last 12 hours',
100 |     value: '12h',
101 |   },
102 |   {
103 |     label: 'Last 24 hours',
104 |     value: '24h',
105 |   },
106 |   {
107 |     label: 'Last 3 days',
108 |     value: '3d',
109 |   },
110 |   {
111 |     label: 'Last week',
112 |     value: '1w',
113 |   },
114 |   {
115 |     label: 'Last month',
116 |     value: '1M',
117 |   },
118 | ];
119 | 


--------------------------------------------------------------------------------
/web/src/index.tsx:
--------------------------------------------------------------------------------
1 | import { createRoot } from 'react-dom/client';
2 | 
3 | import App from './App';
4 | 
5 | const container = document.getElementById('clo-wrapper');
6 | const root = createRoot(container!);
7 | 
8 | root.render(<App />);
9 | 


--------------------------------------------------------------------------------
/web/src/layout/Layout.module.css:
--------------------------------------------------------------------------------
 1 | @media (min-width: 768px) {
 2 |   .wrapper {
 3 |     margin-top: 81px;
 4 |   }
 5 | 
 6 |   :global(.noScroll-modal) .wrapper,
 7 |   :global(.noScroll-sidebar) .wrapper {
 8 |     margin-top: 0px;
 9 |   }
10 | }
11 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/Audit.module.css:
--------------------------------------------------------------------------------
  1 | .navbar {
  2 |   background-color: var(--clo-secondary-15);
  3 |   padding: 1rem 0;
  4 | }
  5 | 
  6 | .filtersNavbar {
  7 |   background-color: var(--clo-secondary-5);
  8 |   padding: 1rem 0;
  9 |   min-height: 85px;
 10 | }
 11 | 
 12 | .searchResults {
 13 |   font-size: 0.9rem;
 14 |   margin-right: 3rem;
 15 | }
 16 | 
 17 | label {
 18 |   font-size: 0.9rem;
 19 | }
 20 | 
 21 | .filters {
 22 |   background-color: var(--bg-color);
 23 |   border-color: var(--solid-border) !important;
 24 | }
 25 | 
 26 | .filters :global(.vr) {
 27 |   background-color: var(--solid-border);
 28 |   opacity: 1;
 29 | }
 30 | 
 31 | .filters small {
 32 |   font-size: 0.75rem;
 33 | }
 34 | 
 35 | .selected {
 36 |   font-size: 1rem;
 37 | }
 38 | 
 39 | .filterSection {
 40 |   min-width: 292px;
 41 |   margin: 0 3rem;
 42 | }
 43 | 
 44 | /* Filters */
 45 | .sidebar {
 46 |   width: 225px;
 47 |   min-width: 225px;
 48 |   background-color: var(--bg-color);
 49 |   margin-top: 2rem;
 50 |   margin-right: 1.5rem;
 51 | }
 52 | 
 53 | .btnMobileFilters {
 54 |   height: 2rem;
 55 |   width: 2rem;
 56 | }
 57 | 
 58 | .filtersBadge::before {
 59 |   content: '';
 60 |   position: absolute;
 61 |   top: -2px;
 62 |   right: -2px;
 63 |   background-color: var(--clo-tertiary);
 64 |   border: 2px solid #dfdbe5;
 65 |   width: 10px;
 66 |   height: 10px;
 67 |   border-radius: 50%;
 68 | }
 69 | 
 70 | [data-theme='dark'] .filtersBadge::before {
 71 |   border-color: #1c1d21;
 72 | }
 73 | 
 74 | .list {
 75 |   margin-top: 1.1rem;
 76 | }
 77 | 
 78 | .contentWrapper {
 79 |   width: calc(100% - 225px - 1.5rem);
 80 |   max-width: calc(100% - 225px - 1.5rem);
 81 | }
 82 | 
 83 | /* Table */
 84 | .table {
 85 |   max-width: 100%;
 86 |   table-layout: fixed;
 87 | }
 88 | 
 89 | .table > :not(caption) > * > * {
 90 |   background-color: transparent;
 91 |   color: inherit;
 92 | }
 93 | 
 94 | .tableHeader {
 95 |   font-size: 0.85rem;
 96 | }
 97 | 
 98 | .tableHeader th:nth-child(1) {
 99 |   width: 90px;
100 | }
101 | 
102 | .tableHeader th:nth-child(3) {
103 |   width: 157px;
104 | }
105 | 
106 | .tableHeader th:nth-child(4) {
107 |   width: 70px;
108 | }
109 | 
110 | .tableHeader th:nth-child(5) {
111 |   width: 175px;
112 | }
113 | 
114 | .tableHeader th:nth-child(6) {
115 |   width: 70px;
116 | }
117 | 
118 | .tableContent td {
119 |   font-size: 0.8rem;
120 |   color: var(--color-font) !important;
121 |   padding: 0.5rem 0.65rem;
122 | }
123 | 
124 | .tableContent > tr:nth-child(odd) > td {
125 |   background-color: rgba(0, 0, 0, 0.04);
126 | }
127 | 
128 | [data-theme='dark'] .tableContent > tr:nth-child(odd) > td {
129 |   --bs-table-accent-bg: rgba(255, 255, 255, 0.05);
130 | }
131 | 
132 | .tableContent small {
133 |   font-size: 0.5rem;
134 | }
135 | 
136 | .maxWidthTruncate3opts {
137 |   max-width: 86px;
138 | }
139 | 
140 | .maxWidthTruncate2opts {
141 |   max-width: 130px;
142 | }
143 | 
144 | .arrow {
145 |   margin-top: 7px;
146 | }
147 | 
148 | .tooltip {
149 |   font-size: 0.8rem;
150 | }
151 | 
152 | .tooltip span {
153 |   font-size: 0.65rem;
154 | }
155 | 
156 | .tooltip ul {
157 |   list-style-type: '- ';
158 |   padding-left: 1rem;
159 |   margin-bottom: 0;
160 | }
161 | 
162 | .tooltipWrapper {
163 |   margin-left: -3px;
164 | }
165 | 
166 | .dropdown {
167 |   left: -450px;
168 | }
169 | 
170 | .dropdownArrow {
171 |   left: 467px !important;
172 | }
173 | 
174 | .codeError {
175 |   font-size: 0.8rem;
176 |   background-color: var(--color-black-5);
177 |   max-height: 130px;
178 | }
179 | 
180 | @media only screen and (min-width: 1400px) {
181 |   .sidebar {
182 |     width: 250px;
183 |     min-width: 250px;
184 |     margin-right: 1.3rem;
185 |   }
186 | 
187 |   .contentWrapper {
188 |     width: calc(100% - 250px - 1.3rem);
189 |     max-width: calc(100% - 250px - 1.3rem);
190 |   }
191 | 
192 |   .maxWidthTruncate3opts {
193 |     max-width: 150px;
194 |   }
195 | 
196 |   .maxWidthTruncate2opts {
197 |     max-width: 205px;
198 |   }
199 | }
200 | 
201 | @media only screen and (max-width: 991.98px) {
202 |   .loading {
203 |     top: 128px !important;
204 |   }
205 | 
206 |   .loadingWithFilters {
207 |     top: 167px !important;
208 |   }
209 | 
210 |   .list {
211 |     margin-top: 1rem;
212 |   }
213 | }
214 | 
215 | @media only screen and (max-width: 767.98px) {
216 |   .contentWrapper {
217 |     width: 100%;
218 |     max-width: 100%;
219 |   }
220 | 
221 |   .loading,
222 |   .loadingWithFilters {
223 |     top: 160px !important;
224 |   }
225 | }
226 | 
227 | @media only screen and (max-width: 575.98px) {
228 |   .loading,
229 |   .loadingWithFilters {
230 |     top: 207px !important;
231 |   }
232 | 
233 |   .extraMargin {
234 |     margin-top: 3rem !important;
235 |     margin-bottom: 3rem !important;
236 |   }
237 | }
238 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/SearchTipsModal.module.css:
--------------------------------------------------------------------------------
 1 | .closeModalBtn {
 2 |   margin: -1rem;
 3 | }
 4 | 
 5 | @media only screen and (max-width: 767.98px) {
 6 |   .title {
 7 |     font-size: 1.25rem;
 8 |   }
 9 | 
10 |   .list {
11 |     padding-inline-start: 20px;
12 |   }
13 | }
14 | 
15 | @media only screen and (max-width: 991.98px) {
16 |   .list {
17 |     font-size: 0.9rem;
18 |   }
19 | }
20 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/SearchTipsModal.tsx:
--------------------------------------------------------------------------------
 1 | import { Modal } from 'clo-ui';
 2 | import { FaRegLightbulb } from 'react-icons/fa';
 3 | import { Link } from 'react-router-dom';
 4 | 
 5 | import { SEARCH_TIPS } from '../../data';
 6 | import { SearchTipItem } from '../../types';
 7 | import prepareQueryString from '../../utils/prepareQueryString';
 8 | import styles from './SearchTipsModal.module.css';
 9 | 
10 | interface Props {
11 |   openTips: boolean;
12 |   setOpenTips: (status: boolean) => void;
13 | }
14 | 
15 | const SearchTipsModal = (props: Props) => {
16 |   if (!props.openTips) return null;
17 | 
18 |   return (
19 |     <Modal noFooter onClose={() => props.setOpenTips(false)} open={props.openTips}>
20 |       <div className="mw-100 text-start text-dark">
21 |         <div className="d-flex flex-row justify-content-between mb-4">
22 |           <div className={`h3 d-flex flex-row align-items-baseline ${styles.title}`}>
23 |             Search tips
24 |             <FaRegLightbulb className="ms-2" />
25 |           </div>
26 | 
27 |           <div>
28 |             <button
29 |               type="button"
30 |               className={`btn-close p-3 ${styles.closeModalBtn}`}
31 |               onClick={() => {
32 |                 props.setOpenTips(false);
33 |               }}
34 |               aria-label="Close"
35 |             ></button>
36 |           </div>
37 |         </div>
38 | 
39 |         <ul className={`mb-0 ${styles.list}`}>
40 |           {SEARCH_TIPS.map((tip: SearchTipItem, index: number) => (
41 |             <li className="my-1" key={`searchBarTip_${index}`}>
42 |               {tip.content} <br className="d-inline-block d-lg-none" />
43 |               <small className="text-muted">Example:</small>{' '}
44 |               <Link
45 |                 className="fw-bold text-dark p-0"
46 |                 onClick={() => props.setOpenTips(false)}
47 |                 to={{
48 |                   pathname: '/search',
49 |                   search: prepareQueryString({
50 |                     pageNumber: 1,
51 |                     ts_query_web: tip.example,
52 |                     filters: {},
53 |                   }),
54 |                 }}
55 |                 aria-label={`Filter by ${tip.example}`}
56 |               >
57 |                 <u>{tip.example}</u>
58 |               </Link>
59 |             </li>
60 |           ))}
61 |         </ul>
62 |       </div>
63 |     </Modal>
64 |   );
65 | };
66 | 
67 | export default SearchTipsModal;
68 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/Searchbar.module.css:
--------------------------------------------------------------------------------
 1 | .wrapper {
 2 |   padding-left: 0.3rem;
 3 | }
 4 | 
 5 | .questionMark {
 6 |   margin-left: 0.25rem;
 7 |   margin-top: -0.25rem;
 8 | }
 9 | 
10 | .search {
11 |   box-shadow: 0 0 0 0.3rem var(--color-black-10) !important;
12 | }
13 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/Searchbar.tsx:
--------------------------------------------------------------------------------
 1 | import { scrollToTop, Searchbar as SearchbarForm } from 'clo-ui';
 2 | import { useEffect, useState } from 'react';
 3 | // import { FaRegQuestionCircle } from 'react-icons/fa';
 4 | import { useNavigate, useSearchParams } from 'react-router-dom';
 5 | 
 6 | import prepareQueryString from '../../utils/prepareQueryString';
 7 | import styles from './Searchbar.module.css';
 8 | // import SearchTipsModal from './SearchTipsModal';
 9 | 
10 | const Searchbar = () => {
11 |   // const [openTips, setOpenTips] = useState<boolean>(false);
12 |   const navigate = useNavigate();
13 |   const [searchParams] = useSearchParams();
14 |   const [value, setValue] = useState<string>('');
15 |   const [currentSearch, setCurrentSearch] = useState<string | null>(null);
16 | 
17 |   useEffect(() => {
18 |     const text = searchParams.get('ts_query_web');
19 |     setValue(text || '');
20 |     setCurrentSearch(text);
21 |   }, [searchParams]);
22 | 
23 |   const search = () => {
24 |     scrollToTop();
25 |     navigate({
26 |       pathname: '/audit/',
27 |       search: prepareQueryString({
28 |         pageNumber: 1,
29 |         ts_query_web: value,
30 |         filters: {},
31 |       }),
32 |     });
33 |   };
34 | 
35 |   const cleanSearchValue = () => {
36 |     if (currentSearch === value) {
37 |       scrollToTop();
38 |       navigate({
39 |         pathname: '/audit/',
40 |         search: prepareQueryString({
41 |           pageNumber: 1,
42 |           ts_query_web: '',
43 |           filters: {},
44 |         }),
45 |       });
46 |     } else {
47 |       setValue('');
48 |     }
49 |   };
50 | 
51 |   return (
52 |     <div className={`d-flex flex-row w-75 my-2 position-relative ${styles.wrapper}`}>
53 |       <SearchbarForm
54 |         value={value}
55 |         onValueChange={(newValue: string) => setValue(newValue)}
56 |         onSearch={search}
57 |         cleanSearchValue={cleanSearchValue}
58 |         placeholder="Search changes"
59 |         classNameWrapper="w-100"
60 |         classNameSearch={`w-100 ${styles.search}`}
61 |         bigSize={false}
62 |       />
63 |       {/* <div className={`d-none d-sm-inline-block ${styles.questionMark}`}>
64 |         <button className="btn btn-link text-decoration-none" onClick={() => setOpenTips(!openTips)}>
65 |           <FaRegQuestionCircle className={`position-absolute ${styles.question}`} />
66 |         </button>
67 |       </div>
68 |       <div>
69 |         <SearchTipsModal openTips={openTips} setOpenTips={setOpenTips} />
70 |       </div> */}
71 |     </div>
72 |   );
73 | };
74 | 
75 | export default Searchbar;
76 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/Filters.module.css:
--------------------------------------------------------------------------------
 1 | .filters label {
 2 |   font-size: 0.8rem;
 3 | }
 4 | 
 5 | .categoryTitle {
 6 |   margin-top: 2rem;
 7 | }
 8 | 
 9 | :global(.input-group-sm),
10 | :global(.input-group-append) {
11 |   height: 31px;
12 | }
13 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/Filters.tsx:
--------------------------------------------------------------------------------
 1 | import { FilterSection, FiltersSection, InputFiltersSection } from 'clo-ui';
 2 | import { isEmpty, isUndefined } from 'lodash';
 3 | import React from 'react';
 4 | import { IoMdCloseCircleOutline } from 'react-icons/io';
 5 | 
 6 | import { FILTERS, SEARCHABLE_FILTERS } from '../../../data';
 7 | import { FilterKind } from '../../../types';
 8 | import styles from './Filters.module.css';
 9 | import OrganizationsSelect from './OrganizationsSelect';
10 | import TimeRange from './TimeRange';
11 | 
12 | interface Props {
13 |   organizations?: string[];
14 |   selectedOrg?: string | null;
15 |   onOrganizationChange: (org: string) => void;
16 |   timeRange?: string;
17 |   visibleTitle: boolean;
18 |   activeFilters: {
19 |     [key: string]: string[];
20 |   };
21 |   onChange: (name: string, value: string, checked: boolean, type?: string) => void;
22 |   onDateRangeChange: (timeRange?: string) => void;
23 |   onResetFilters?: () => void;
24 |   device: string;
25 | }
26 | 
27 | const Filters = (props: Props) => {
28 |   return (
29 |     <div className={styles.filters}>
30 |       {props.visibleTitle && (
31 |         <div className="d-flex flex-row align-items-center justify-content-between pb-2 mb-4 border-bottom">
32 |           <div className="h6 text-uppercase mb-0 lh-base text-primary fw-bold">Filters</div>
33 |           {(!isEmpty(props.activeFilters) || !isUndefined(props.timeRange)) && (
34 |             <button className="btn btn-link text-primary" onClick={props.onResetFilters} aria-label="Reset filters">
35 |               <div className="d-flex flex-row align-items-center">
36 |                 <IoMdCloseCircleOutline className="me-2" />
37 | 
38 |                 <small>Reset</small>
39 |               </div>
40 |             </button>
41 |           )}
42 |         </div>
43 |       )}
44 | 
45 |       <div className={`fw-bold text-uppercase text-primary ${styles.categoryTitle}`}>
46 |         <small>Organization</small>
47 |       </div>
48 | 
49 |       <OrganizationsSelect
50 |         selectedOrg={props.selectedOrg}
51 |         organizations={props.organizations}
52 |         onOrganizationChange={props.onOrganizationChange}
53 |       />
54 | 
55 |       <div className={`fw-bold text-uppercase text-primary ${styles.categoryTitle}`}>
56 |         <small>Time range</small>
57 |       </div>
58 | 
59 |       <TimeRange onDateRangeChange={props.onDateRangeChange} value={props.timeRange} />
60 | 
61 |       {FILTERS.map((section: FilterSection) => {
62 |         const activeFilters = props.activeFilters[section.key!];
63 |         return (
64 |           <React.Fragment key={`sec_${section.key}`}>
65 |             <FiltersSection
66 |               device={props.device}
67 |               activeFilters={activeFilters}
68 |               section={section}
69 |               onChange={props.onChange}
70 |               visibleTitle
71 |             />
72 |           </React.Fragment>
73 |         );
74 |       })}
75 | 
76 |       {SEARCHABLE_FILTERS.map((section: FilterSection) => {
77 |         const activeFilters = props.activeFilters[section.key!];
78 |         return (
79 |           <React.Fragment key={`sec_${section.key}`}>
80 |             <InputFiltersSection
81 |               device={props.device}
82 |               activeFilters={activeFilters}
83 |               section={section}
84 |               inputType={section.key! === FilterKind.PRNumber ? 'number' : undefined}
85 |               decoratorActiveFilter={section.key! === FilterKind.PRNumber ? '#' : undefined}
86 |               onChange={props.onChange}
87 |             />
88 |           </React.Fragment>
89 |         );
90 |       })}
91 |     </div>
92 |   );
93 | };
94 | 
95 | export default Filters;
96 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/OrganizationsSelect.module.css:
--------------------------------------------------------------------------------
1 | .loadingWrapper {
2 |   top: 0.15rem;
3 |   left: 0.3rem;
4 | }
5 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/OrganizationsSelect.tsx:
--------------------------------------------------------------------------------
 1 | import { isNull, isUndefined } from 'lodash';
 2 | import { ChangeEvent, useRef } from 'react';
 3 | 
 4 | import styles from './OrganizationsSelect.module.css';
 5 | 
 6 | interface Props {
 7 |   organizations?: string[];
 8 |   selectedOrg?: string | null;
 9 |   onOrganizationChange: (org: string) => void;
10 | }
11 | 
12 | const OrganizationsSelect = (props: Props) => {
13 |   const select = useRef<HTMLSelectElement>(null);
14 | 
15 |   const forceBlur = (): void => {
16 |     if (!isNull(select) && !isNull(select.current)) {
17 |       select.current.blur();
18 |     }
19 |   };
20 | 
21 |   return (
22 |     <div className="position-relative mt-2 mb-3">
23 |       <select
24 |         ref={select}
25 |         className="form-select form-select-sm rounded-0 cursorPointer"
26 |         aria-label="org-select"
27 |         value={props.selectedOrg || ''}
28 |         onChange={(e: ChangeEvent<HTMLSelectElement>) => {
29 |           props.onOrganizationChange(e.target.value);
30 |           forceBlur();
31 |         }}
32 |       >
33 |         {!isUndefined(props.organizations) && (
34 |           <>
35 |             {props.organizations.map((org: string) => (
36 |               <option key={`org_${org}`} value={org}>
37 |                 {org}
38 |               </option>
39 |             ))}
40 |           </>
41 |         )}
42 |       </select>
43 |       {isUndefined(props.selectedOrg) && (
44 |         <div className={`position-absolute ${styles.loadingWrapper}`}>
45 |           <span className="spinner-border text-primary spinner-border-sm" role="status" aria-hidden="true" />
46 |         </div>
47 |       )}
48 |     </div>
49 |   );
50 | };
51 | 
52 | export default OrganizationsSelect;
53 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/SelectedFilters.module.css:
--------------------------------------------------------------------------------
 1 | .badges {
 2 |   top: -2px;
 3 | }
 4 | 
 5 | .badge {
 6 |   padding: 0;
 7 |   padding-left: 0.35rem;
 8 |   border: 1px solid transparent;
 9 | }
10 | 
11 | .content {
12 |   padding: 0.1rem 0;
13 | }
14 | 
15 | .btn {
16 |   padding: 0.1rem 0.35rem;
17 | }
18 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/SelectedFilters.tsx:
--------------------------------------------------------------------------------
 1 | import { SelectedFilterBadge } from 'clo-ui';
 2 | import { isEmpty, isUndefined } from 'lodash';
 3 | import { Fragment } from 'react';
 4 | import { IoMdCloseCircleOutline } from 'react-icons/io';
 5 | 
 6 | import { DATE_RANGE, FILTER_CATEGORY_NAMES } from '../../../data';
 7 | import { FilterKind, Option } from '../../../types';
 8 | import styles from './SelectedFilters.module.css';
 9 | 
10 | interface Props {
11 |   timeRange?: string;
12 |   filters: { [key: string]: string[] };
13 |   onChange: (name: string, value: string, checked: boolean) => void;
14 |   onDateRangeChange: (timeRange?: string) => void;
15 | }
16 | 
17 | const SelectedFilters = (props: Props) => {
18 |   if (isEmpty(props.filters) && isUndefined(props.timeRange)) return null;
19 | 
20 |   const getFilterName = (type: FilterKind, filter: string): string => {
21 |     switch (type) {
22 |       case FilterKind.PRNumber:
23 |         return `#${filter}`;
24 |     }
25 |     return filter;
26 |   };
27 | 
28 |   const getTimeRangeName = (timeRange: string): string | null => {
29 |     const selectedTimeRange = DATE_RANGE.find((d: Option) => d.value === timeRange);
30 |     if (selectedTimeRange) {
31 |       return selectedTimeRange.label;
32 |     }
33 |     return null;
34 |   };
35 | 
36 |   return (
37 |     <div className="d-none d-md-block mt-4">
38 |       <div className="d-flex flex-row justify-content-start align-items-baseline">
39 |         <div className="me-3">Filters:</div>
40 |         <div role="list" className={`position-relative ${styles.badges}`}>
41 |           {!isUndefined(props.timeRange) && (
42 |             <span
43 |               role="listitem"
44 |               className={`badge bg-secondary rounded-0 text-light me-3 my-1 ${styles.badge} lightBorder`}
45 |             >
46 |               <div className="d-flex flex-row align-items-baseline">
47 |                 <div className={styles.content}>
48 |                   <small className="text-uppercase fw-normal me-2">Time range:</small>
49 |                   {getTimeRangeName(props.timeRange)}
50 |                 </div>
51 |                 <button
52 |                   className={`btn btn-link btn-sm lh-1 ${styles.btn}`}
53 |                   onClick={() => props.onDateRangeChange(undefined)}
54 |                   aria-label="Remove date range filter"
55 |                 >
56 |                   <IoMdCloseCircleOutline />
57 |                 </button>
58 |               </div>
59 |             </span>
60 |           )}
61 |           {Object.keys(props.filters).map((category: string) => {
62 |             const categoryName = FILTER_CATEGORY_NAMES[category as FilterKind];
63 |             return (
64 |               <Fragment key={`filter_${category}`}>
65 |                 {props.filters[category].map((filter: string) => {
66 |                   const filterName = getFilterName(category as FilterKind, filter);
67 |                   return (
68 |                     <Fragment key={`filter_${category}_${filter}`}>
69 |                       <SelectedFilterBadge
70 |                         categoryName={categoryName}
71 |                         category={category}
72 |                         filterName={filterName}
73 |                         filter={filter}
74 |                         onClick={() => props.onChange(category, filter as string, false)}
75 |                       />
76 |                     </Fragment>
77 |                   );
78 |                 })}
79 |               </Fragment>
80 |             );
81 |           })}
82 |         </div>
83 |       </div>
84 |     </div>
85 |   );
86 | };
87 | 
88 | export default SelectedFilters;
89 | 


--------------------------------------------------------------------------------
/web/src/layout/audit/filters/TimeRange.tsx:
--------------------------------------------------------------------------------
 1 | import { isNull } from 'lodash';
 2 | import { ChangeEvent, useRef } from 'react';
 3 | 
 4 | import { DATE_RANGE, DEFAULT_TIME_RANGE } from '../../../data';
 5 | import { Option } from '../../../types';
 6 | 
 7 | export interface Props {
 8 |   onDateRangeChange: (timeRange?: string) => void;
 9 |   value?: string;
10 | }
11 | 
12 | const TimeRange = (props: Props) => {
13 |   const selectEl = useRef<HTMLSelectElement>(null);
14 | 
15 |   const handleChange = (event: ChangeEvent<HTMLSelectElement>) => {
16 |     props.onDateRangeChange(event.target.value);
17 |     forceBlur();
18 |   };
19 | 
20 |   const forceBlur = (): void => {
21 |     if (!isNull(selectEl) && !isNull(selectEl.current)) {
22 |       selectEl.current.blur();
23 |     }
24 |   };
25 | 
26 |   return (
27 |     <div className="mt-2 mb-3">
28 |       <select
29 |         ref={selectEl}
30 |         className="form-select form-select-sm rounded-0 cursorPointer"
31 |         value={props.value || DEFAULT_TIME_RANGE}
32 |         onChange={handleChange}
33 |         aria-label="Date range select"
34 |       >
35 |         {DATE_RANGE.map((opt: Option) => (
36 |           <option key={`date_${opt.value}`} value={opt.value}>
37 |             {opt.label}
38 |           </option>
39 |         ))}
40 |       </select>
41 |     </div>
42 |   );
43 | };
44 | 
45 | export default TimeRange;
46 | 


--------------------------------------------------------------------------------
/web/src/layout/index.tsx:
--------------------------------------------------------------------------------
 1 | import { useScrollRestorationFix } from 'clo-ui';
 2 | import { useState } from 'react';
 3 | import { Outlet } from 'react-router-dom';
 4 | 
 5 | import styles from './Layout.module.css';
 6 | import Footer from './navigation/Footer';
 7 | import Navbar from './navigation/Navbar';
 8 | 
 9 | const Layout = () => {
10 |   const [invisibleFooter, setInvisibleFooter] = useState<boolean>(false);
11 | 
12 |   useScrollRestorationFix();
13 | 
14 |   return (
15 |     <div className="h-100 d-flex flex-column">
16 |       <Navbar />
17 |       <div className={`d-flex flex-column flex-grow-1 ${styles.wrapper}`}>
18 |         <Outlet context={{ setInvisibleFooter }} />
19 |       </div>
20 |       <Footer invisibleFooter={invisibleFooter} />
21 |     </div>
22 |   );
23 | };
24 | 
25 | export default Layout;
26 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Footer.module.css:
--------------------------------------------------------------------------------
 1 | .logo {
 2 |   height: 30px;
 3 | }
 4 | 
 5 | .miniIcon {
 6 |   font-size: 0.75rem;
 7 | }
 8 | 
 9 | .footerCol {
10 |   padding-right: 5rem;
11 | }
12 | 
13 | @media only screen and (max-width: 991.98px) {
14 |   .footerCol {
15 |     padding: 0 1rem;
16 |     padding-bottom: 1.5rem;
17 |   }
18 | }
19 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Footer.tsx:
--------------------------------------------------------------------------------
 1 | import { ExternalLink } from 'clo-ui';
 2 | import { Footer as FooterWrapper } from 'clo-ui';
 3 | import { FaGithub } from 'react-icons/fa';
 4 | import { FiExternalLink } from 'react-icons/fi';
 5 | 
 6 | import logo from '../../media/clowarden.svg';
 7 | import styles from './Footer.module.css';
 8 | 
 9 | interface Props {
10 |   invisibleFooter: boolean;
11 | }
12 | 
13 | const Footer = (props: Props) => {
14 |   return (
15 |     <FooterWrapper
16 |       className={props.invisibleFooter ? 'opacity-0' : ''}
17 |       // logo={<></>}
18 |       logo={<img className={styles.logo} alt="Logo" src={logo} />}
19 |     >
20 |       <>
21 |         <div className={styles.footerCol}>
22 |           <div className="h6 fw-bold text-uppercase">Project</div>
23 |           <div className="d-flex flex-column text-start">
24 |             <ExternalLink
25 |               className="mb-1 opacity-75"
26 |               href="https://github.com/cncf/clowarden#readme"
27 |               label="Open documentation"
28 |               target="_self"
29 |             >
30 |               Documentation
31 |             </ExternalLink>
32 |           </div>
33 |         </div>
34 | 
35 |         <div className={styles.footerCol}>
36 |           <div className="h6 fw-bold text-uppercase">Community</div>
37 |           <div className="d-flex flex-column text-start">
38 |             <ExternalLink className="mb-1 opacity-75" href="https://github.com/cncf/clowarden" label="Open Github">
39 |               <div className="d-flex align-items-center">
40 |                 <FaGithub className="me-2" />
41 |                 GitHub
42 |               </div>
43 |             </ExternalLink>
44 |           </div>
45 |         </div>
46 | 
47 |         <div className={styles.footerCol}>
48 |           <div className="h6 fw-bold text-uppercase">About</div>
49 |           <div className="opacity-75 d-flex flex-column">
50 |             CLOWarden is an <b className="d-inline-block">Open Source</b> project licensed under the{' '}
51 |             <ExternalLink
52 |               className="d-inline-block mb-1"
53 |               href="https://www.apache.org/licenses/LICENSE-2.0"
54 |               label="Open Apache License 2.0 documentation"
55 |             >
56 |               <div className="d-flex align-items-center">
57 |                 Apache License 2.0
58 |                 <FiExternalLink className={`ms-1 ${styles.miniIcon}`} />
59 |               </div>
60 |             </ExternalLink>
61 |           </div>
62 |         </div>
63 |       </>
64 |     </FooterWrapper>
65 |   );
66 | };
67 | 
68 | export default Footer;
69 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/MobileSettings.module.css:
--------------------------------------------------------------------------------
 1 | .btn {
 2 |   padding: 0.25rem 0.35rem;
 3 |   margin-top: -0.25rem;
 4 | }
 5 | 
 6 | .dropdown {
 7 |   right: 0;
 8 |   top: 30px;
 9 |   font-size: 0.9rem;
10 |   width: 175px;
11 | }
12 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/MobileSettings.tsx:
--------------------------------------------------------------------------------
 1 | import classNames from 'classnames';
 2 | import { ExternalLink, useOutsideClick } from 'clo-ui';
 3 | import { useRef, useState } from 'react';
 4 | import { BsList } from 'react-icons/bs';
 5 | import { FaGithub } from 'react-icons/fa';
 6 | 
 7 | import styles from './MobileSettings.module.css';
 8 | import ThemeMode from './ThemeMode';
 9 | 
10 | const MobileSettings = () => {
11 |   const [visibleDropdown, setVisibleDropdown] = useState(false);
12 |   const ref = useRef(null);
13 |   useOutsideClick([ref], visibleDropdown, () => setVisibleDropdown(false));
14 | 
15 |   return (
16 |     <div ref={ref} className="d-flex d-md-none ms-auto position-relative">
17 |       <button
18 |         className={`btn btn-sm btn-link text-white rounded-0 lh-1 fs-5 ms-3 ${styles.btn}`}
19 |         type="button"
20 |         onClick={() => setVisibleDropdown(!visibleDropdown)}
21 |         aria-label="Mobile settings button"
22 |         aria-expanded={visibleDropdown}
23 |       >
24 |         <BsList />
25 |       </button>
26 | 
27 |       <div role="menu" className={classNames('dropdown-menu rounded-0', styles.dropdown, { show: visibleDropdown })}>
28 |         <ThemeMode device="mobile" closeDropdown={() => setVisibleDropdown(false)} />
29 | 
30 |         <hr />
31 | 
32 |         <div className="dropdown-item mb-2">
33 |           <ExternalLink
34 |             className="text-decoration-none fw-bold d-inline-block w-100"
35 |             label="Github link"
36 |             href="https://github.com/cncf/clowarden"
37 |           >
38 |             <div className="d-flex flex-row align-items-center py-1">
39 |               <FaGithub />
40 |               <div className="ms-2">Github</div>
41 |             </div>
42 |           </ExternalLink>
43 |         </div>
44 |       </div>
45 |     </div>
46 |   );
47 | };
48 | 
49 | export default MobileSettings;
50 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Navbar.module.css:
--------------------------------------------------------------------------------
 1 | .navbar {
 2 |   min-height: 81px;
 3 | }
 4 | 
 5 | .logo {
 6 |   height: 25px;
 7 | }
 8 | 
 9 | .link {
10 |   letter-spacing: 2px;
11 | }
12 | 
13 | .ghLink {
14 |   margin-top: -2px;
15 | }
16 | 
17 | .alpha {
18 |   background-color: var(--color-white-25);
19 |   top: -8px;
20 |   font-size: 0.6rem;
21 | }
22 | 
23 | [data-theme='dark'] .alpha {
24 |   background-color: var(--color-black-25);
25 | }
26 | 
27 | @media (hover: hover) {
28 |   .link:hover::before {
29 |     content: '';
30 |     position: absolute;
31 |     top: -28px;
32 |     left: 0;
33 |     right: 0;
34 |     height: 4px;
35 |     background-color: var(--bs-white);
36 |     opacity: 0.5;
37 |   }
38 | }
39 | 
40 | @media only screen and (max-width: 767.98px) {
41 |   .line {
42 |     width: 100%;
43 |   }
44 | }
45 | 
46 | @media (min-width: 768px) {
47 |   :global(.noScroll-modal) .navbar,
48 |   :global(.noScroll-sidebar) .navbar {
49 |     min-height: 81px;
50 |   }
51 | }
52 | 
53 | @media only screen and (max-width: 359.98px) {
54 |   .logo {
55 |     height: 19px;
56 |   }
57 | 
58 |   .alpha {
59 |     font-size: 0.4rem;
60 |   }
61 | }
62 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Navbar.tsx:
--------------------------------------------------------------------------------
 1 | import { ExternalLink, Navbar as NavbarWrapper, scrollToTop } from 'clo-ui';
 2 | import { FaGithub } from 'react-icons/fa';
 3 | import { Link } from 'react-router-dom';
 4 | 
 5 | import logo from '../../media/clowarden.svg';
 6 | import MobileSettings from './MobileSettings';
 7 | import styles from './Navbar.module.css';
 8 | import Settings from './Settings';
 9 | 
10 | const Navbar = () => {
11 |   return (
12 |     <NavbarWrapper navbarClassname={styles.navbar}>
13 |       <>
14 |         <div className={`me-0 me-md-4 mt-2 mt-md-0 ${styles.line}`}>
15 |           <div className="d-flex flex-row align-items-start">
16 |             <div className="position-relative">
17 |               <Link to="/" onClick={() => scrollToTop()} className="cursorPointer">
18 |                 <img className={styles.logo} alt="CLOWarden logo" src={logo} />
19 |               </Link>
20 |               <div
21 |                 className={`position-relative badge rounded-0 text-uppercase fw-bold me-2 me-sm-3 ms-2 ${styles.alpha}`}
22 |               >
23 |                 Alpha
24 |               </div>
25 |             </div>
26 | 
27 |             <MobileSettings />
28 |           </div>
29 |         </div>
30 | 
31 |         <div className="d-none d-md-flex flex-row align-items-center ms-auto">
32 |           <Link
33 |             to="/audit"
34 |             className={`position-relative mx-4 text-light text-uppercase fw-bold text-decoration-none ${styles.link} navbarLink`}
35 |           >
36 |             Audit
37 |           </Link>
38 |           <ExternalLink
39 |             className={`btn btn-md text-light fs-5 ${styles.ghLink}`}
40 |             label="Github link"
41 |             href="https://github.com/cncf/clowarden"
42 |           >
43 |             <FaGithub />
44 |           </ExternalLink>
45 |           <Settings />
46 |         </div>
47 |       </>
48 |     </NavbarWrapper>
49 |   );
50 | };
51 | 
52 | export default Navbar;
53 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Settings.module.css:
--------------------------------------------------------------------------------
 1 | .btn {
 2 |   padding: 0.25rem 0.35rem;
 3 | }
 4 | 
 5 | .dropdown {
 6 |   right: 0;
 7 |   top: 30px;
 8 |   font-size: 0.9rem;
 9 |   width: 175px;
10 | }
11 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/Settings.tsx:
--------------------------------------------------------------------------------
 1 | import { Dropdown } from 'clo-ui';
 2 | import { FaCog } from 'react-icons/fa';
 3 | 
 4 | import styles from './Settings.module.css';
 5 | import ThemeMode from './ThemeMode';
 6 | 
 7 | const Settings = () => {
 8 |   return (
 9 |     <Dropdown
10 |       label="Settings"
11 |       btnContent={<FaCog />}
12 |       btnClassName={`btn btn-md btn-link text-white rounded-0 lh-1 fs-5 ${styles.btn}`}
13 |       dropdownClassName={styles.dropdown}
14 |     >
15 |       <ThemeMode device="desktop" />
16 |     </Dropdown>
17 |   );
18 | };
19 | 
20 | export default Settings;
21 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/ThemeMode.module.css:
--------------------------------------------------------------------------------
1 | @media (hover: hover) {
2 |   .input:not([disabled]),
3 |   .input:not([disabled]) + label {
4 |     cursor: pointer;
5 |   }
6 | }
7 | 


--------------------------------------------------------------------------------
/web/src/layout/navigation/ThemeMode.tsx:
--------------------------------------------------------------------------------
 1 | import { ThemeMode as ThemeModeForm } from 'clo-ui';
 2 | import { isUndefined } from 'lodash';
 3 | import { useContext } from 'react';
 4 | 
 5 | import { AppContext, updateTheme } from '../../context/AppContextProvider';
 6 | 
 7 | interface Props {
 8 |   closeDropdown?: () => void;
 9 |   device: string;
10 | }
11 | 
12 | const ThemeMode = (props: Props) => {
13 |   const { ctx, dispatch } = useContext(AppContext);
14 |   const { configured } = ctx.prefs.theme;
15 | 
16 |   const onHandleChange = (value: string) => {
17 |     dispatch(updateTheme(value));
18 |     if (!isUndefined(props.closeDropdown)) {
19 |       props.closeDropdown();
20 |     }
21 |   };
22 | 
23 |   return <ThemeModeForm device={props.device} configuredTheme={configured} onChange={onHandleChange} />;
24 | };
25 | 
26 | export default ThemeMode;
27 | 


--------------------------------------------------------------------------------
/web/src/layout/notFound/NotFound.module.css:
--------------------------------------------------------------------------------
1 | .icon {
2 |   font-size: 4rem;
3 | }
4 | 


--------------------------------------------------------------------------------
/web/src/layout/notFound/index.tsx:
--------------------------------------------------------------------------------
 1 | import { TiWarningOutline } from 'react-icons/ti';
 2 | import { Link } from 'react-router-dom';
 3 | 
 4 | import styles from './NotFound.module.css';
 5 | 
 6 | const NotFound = () => {
 7 |   return (
 8 |     <main
 9 |       role="main"
10 |       className="container-lg flex-grow-1 p-5 d-flex flex-column align-items-center justify-content-center"
11 |     >
12 |       <TiWarningOutline className={`m-3 ${styles.icon}`} />
13 |       <div className="h1 text-center mb-4">Error 404 - Page Not Found</div>
14 |       <div className="h3 text-center mb-5">The page you were looking for wasn't found</div>
15 |       <Link to="/audit" className="btn btn-primary rounded-0 text-white btn-lg text-decoration-none">
16 |         Back Audit
17 |       </Link>
18 |     </main>
19 |   );
20 | };
21 | 
22 | export default NotFound;
23 | 


--------------------------------------------------------------------------------
/web/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/web/src/setupTests.ts:
--------------------------------------------------------------------------------
1 | // jest-dom adds custom jest matchers for asserting on DOM nodes.
2 | // allows you to do things like:
3 | // expect(element).toHaveTextContent(/react/i)
4 | // learn more: https://github.com/testing-library/jest-dom
5 | import '@testing-library/jest-dom';
6 | 


--------------------------------------------------------------------------------
/web/src/types.ts:
--------------------------------------------------------------------------------
  1 | export interface OutletContext {
  2 |   setInvisibleFooter: (value: boolean) => void;
  3 | }
  4 | 
  5 | export interface Prefs {
  6 |   search: { sort: { by: SortBy; direction: SortDirection } };
  7 |   theme: ThemePrefs;
  8 | }
  9 | 
 10 | export interface ThemePrefs {
 11 |   configured: string;
 12 |   effective: string;
 13 | }
 14 | 
 15 | export enum SortDirection {
 16 |   ASC = 'asc',
 17 |   DESC = 'desc',
 18 | }
 19 | 
 20 | export enum SortBy {
 21 |   Date = 'date',
 22 | }
 23 | 
 24 | export enum FilterKind {
 25 |   Service = 'service',
 26 |   Kind = 'kind',
 27 |   PRNumber = 'pr_number',
 28 |   PRMergedBy = 'pr_merged_by',
 29 |   AppliedSuccessfully = 'applied_successfully',
 30 | }
 31 | 
 32 | export enum Service {
 33 |   GitHub = 'github',
 34 | }
 35 | 
 36 | export enum ChangeKind {
 37 |   TeamAdded = 'team-added',
 38 |   TeamRemoved = 'team-removed',
 39 |   TeamMaintainerAdded = 'team-maintainer-added',
 40 |   TeamMaintainerRemoved = 'team-maintainer-removed',
 41 |   TeamMemberAdded = 'team-member-added',
 42 |   TeamMemberRemoved = 'team-member-removed',
 43 |   RepositoryAdded = 'repository-added',
 44 |   RepositoryTeamAdded = 'repository-team-added',
 45 |   RepositoryTeamRemoved = 'repository-team-removed',
 46 |   RepositoryTeamRoleUpdated = 'repository-team-role-updated',
 47 |   RepositoryCollaboratorAdded = 'repository-collaborator-added',
 48 |   RepositoryCollaboratorRemoved = 'repository-collaborator-removed',
 49 |   RepositoryCollaboratorRoleUpdated = 'repository-collaborator-role-updated',
 50 |   RepositoryVisibilityUpdated = 'repository-visibility-updated',
 51 | }
 52 | 
 53 | export interface SortOption {
 54 |   label: string;
 55 |   by: SortBy;
 56 |   direction: SortDirection;
 57 | }
 58 | 
 59 | export interface Option {
 60 |   label: string;
 61 |   value: string;
 62 | }
 63 | 
 64 | export interface Error {
 65 |   kind: ErrorKind;
 66 |   message?: string;
 67 | }
 68 | 
 69 | export enum ErrorKind {
 70 |   Other,
 71 |   NotFound,
 72 | }
 73 | 
 74 | export interface BasicQuery {
 75 |   ts_query_web?: string;
 76 |   time_range?: string;
 77 |   organization?: string;
 78 |   filters?: {
 79 |     [key: string]: string[];
 80 |   };
 81 | }
 82 | 
 83 | export interface SearchQuery extends BasicQuery {
 84 |   limit: number;
 85 |   offset: number;
 86 |   sort_by: SortBy;
 87 |   sort_direction: SortDirection;
 88 | }
 89 | 
 90 | export interface SearchFiltersURL extends BasicQuery {
 91 |   pageNumber: number;
 92 | }
 93 | 
 94 | export interface Change {
 95 |   change_id: string;
 96 |   service: string;
 97 |   kind: string;
 98 |   extra: {
 99 |     // eslint-disable-next-line @typescript-eslint/no-explicit-any
100 |     [key: string]: any;
101 |   };
102 |   applied_at: number;
103 |   error?: string;
104 |   reconciliation: ReconciliationStatus;
105 | }
106 | 
107 | export interface ReconciliationStatus {
108 |   reconciliation_id: string;
109 |   organization?: string;
110 |   completed_at: number;
111 |   error?: string;
112 |   pr_number: string;
113 |   pr_created_by: string;
114 |   pr_merged_by: string;
115 |   pr_merged_at: string;
116 | }
117 | 
118 | export interface SearchTipItem {
119 |   content: JSX.Element | string;
120 |   example: string;
121 | }
122 | 


--------------------------------------------------------------------------------
/web/src/utils/buildSearchParams.ts:
--------------------------------------------------------------------------------
 1 | import isNull from 'lodash/isNull';
 2 | 
 3 | import { FilterKind, SearchFiltersURL } from '../types';
 4 | 
 5 | interface F {
 6 |   [key: string]: string[];
 7 | }
 8 | 
 9 | const WHITELISTED_FILTER_KEYS = [
10 |   FilterKind.Service,
11 |   FilterKind.Kind,
12 |   FilterKind.PRNumber,
13 |   FilterKind.PRMergedBy,
14 |   FilterKind.AppliedSuccessfully,
15 | ];
16 | 
17 | const buildSearchParams = (p: URLSearchParams): SearchFiltersURL => {
18 |   const filters: F = {};
19 | 
20 |   p.forEach((value, key) => {
21 |     if (WHITELISTED_FILTER_KEYS.includes(key as FilterKind)) {
22 |       const values = filters[key] || [];
23 |       values.push(value);
24 |       filters[key] = values;
25 |     }
26 |   });
27 | 
28 |   return {
29 |     ts_query_web: p.has('ts_query_web') ? p.get('ts_query_web')! : undefined,
30 |     time_range: p.has('time_range') ? p.get('time_range')! : undefined,
31 |     filters: { ...filters },
32 |     pageNumber: p.has('page') && !isNull(p.get('page')) ? parseInt(p.get('page')!) : 1,
33 |   };
34 | };
35 | 
36 | export default buildSearchParams;
37 | 


--------------------------------------------------------------------------------
/web/src/utils/calculateTimeRange.ts:
--------------------------------------------------------------------------------
 1 | import moment, { DurationInputArg1, DurationInputArg2 } from 'moment';
 2 | 
 3 | export interface TimeRangeData {
 4 |   from: string;
 5 |   to: string;
 6 | }
 7 | 
 8 | const calculateTimeRange = (timeRange: string): TimeRangeData => {
 9 |   const amount = timeRange.substring(0, timeRange.length - 1);
10 |   const unit = timeRange.slice(-1);
11 | 
12 |   return {
13 |     from: moment()
14 |       .subtract(amount as DurationInputArg1, unit as DurationInputArg2)
15 |       .format('YYYY-MM-DD HH:mm:ssZZ'),
16 |     to: moment().format('YYYY-MM-DD HH:mm:ssZZ'),
17 |   };
18 | };
19 | 
20 | export default calculateTimeRange;
21 | 


--------------------------------------------------------------------------------
/web/src/utils/localStoragePreferences.ts:
--------------------------------------------------------------------------------
  1 | import { detectActiveThemeMode } from 'clo-ui';
  2 | import { isEmpty, sortBy } from 'lodash';
  3 | 
  4 | import { DEFAULT_SORT_BY, DEFAULT_SORT_DIRECTION } from '../data';
  5 | import { Prefs } from '../types';
  6 | 
  7 | export interface PreferencesList {
  8 |   [key: string]: Prefs;
  9 | }
 10 | 
 11 | const LS_ITEM = 'clowardenPrefs';
 12 | const APPLIED_MIGRATION = 'clowardenAppliedMigration';
 13 | const DEFAULT_THEME = 'automatic';
 14 | 
 15 | interface Migration {
 16 |   key: number;
 17 |   description: string;
 18 |   method: (lsActual: PreferencesList) => PreferencesList;
 19 | }
 20 | 
 21 | const DEFAULT_PREFS: Prefs = {
 22 |   search: { sort: { by: DEFAULT_SORT_BY, direction: DEFAULT_SORT_DIRECTION } },
 23 |   theme: { configured: DEFAULT_THEME, effective: detectActiveThemeMode() },
 24 | };
 25 | 
 26 | const migrations: Migration[] = [];
 27 | 
 28 | export const applyMigrations = (lsActual: PreferencesList): PreferencesList => {
 29 |   let lsUpdated: PreferencesList = { ...lsActual };
 30 |   const lastMigration = getLastMigrationNumber();
 31 | 
 32 |   if (isEmpty(lsUpdated)) {
 33 |     lsUpdated = { guest: DEFAULT_PREFS };
 34 |   } else {
 35 |     if (isEmpty(migrations)) return lsUpdated;
 36 |     const sortedMigrations: Migration[] = sortBy(migrations, 'key');
 37 |     let migrationsToApply = [...sortedMigrations];
 38 |     const migrationApplied = window.localStorage.getItem(APPLIED_MIGRATION);
 39 | 
 40 |     if (migrationApplied) {
 41 |       // If latest migration has been applied, we don't do anything
 42 |       if (lastMigration === parseInt(migrationApplied)) {
 43 |         migrationsToApply = [];
 44 |       } else {
 45 |         // Migrations newest than current one are applied to prefs
 46 |         migrationsToApply = sortedMigrations.filter(
 47 |           (migration: Migration) => migration.key > parseInt(migrationApplied)
 48 |         );
 49 |       }
 50 |     }
 51 | 
 52 |     migrationsToApply.forEach((migration: Migration) => {
 53 |       lsUpdated = migration.method(lsUpdated);
 54 |     });
 55 |   }
 56 | 
 57 |   // Saved last migration
 58 |   try {
 59 |     window.localStorage.setItem(LS_ITEM, JSON.stringify(lsUpdated));
 60 |     window.localStorage.setItem(APPLIED_MIGRATION, lastMigration.toString());
 61 |   } catch {
 62 |     // Incognite mode
 63 |   }
 64 |   return lsUpdated;
 65 | };
 66 | 
 67 | const getLastMigrationNumber = (): number => {
 68 |   const sortedMigrations = sortBy(migrations, 'key');
 69 |   if (isEmpty(sortedMigrations)) return 0;
 70 |   return sortedMigrations[sortedMigrations.length - 1].key;
 71 | };
 72 | 
 73 | export class LocalStoragePreferences {
 74 |   private savedPreferences: PreferencesList = { guest: DEFAULT_PREFS };
 75 | 
 76 |   constructor() {
 77 |     try {
 78 |       const preferences = window.localStorage.getItem(LS_ITEM);
 79 |       if (preferences) {
 80 |         this.savedPreferences = applyMigrations(JSON.parse(preferences));
 81 |       } else {
 82 |         this.setPrefs(DEFAULT_PREFS);
 83 |       }
 84 |     } catch {
 85 |       // Incognite mode
 86 |     }
 87 |   }
 88 | 
 89 |   public setPrefs(prefs: Prefs) {
 90 |     const preferences = { ...this.savedPreferences, guest: prefs };
 91 |     this.savedPreferences = preferences;
 92 | 
 93 |     try {
 94 |       window.localStorage.setItem(LS_ITEM, JSON.stringify(preferences));
 95 |     } catch {
 96 |       // Incognite mode
 97 |     }
 98 |   }
 99 | 
100 |   public getPrefs(): Prefs {
101 |     const prefs: Prefs = {
102 |       ...DEFAULT_PREFS,
103 |       ...this.savedPreferences.guest,
104 |     };
105 |     return prefs;
106 |   }
107 | }
108 | 
109 | const lsPreferences = new LocalStoragePreferences();
110 | export default lsPreferences;
111 | 


--------------------------------------------------------------------------------
/web/src/utils/prepareQueryString.ts:
--------------------------------------------------------------------------------
 1 | import { isEmpty, isUndefined } from 'lodash';
 2 | 
 3 | import { BasicQuery, SearchFiltersURL } from '../types';
 4 | 
 5 | const getURLSearchParams = (query: BasicQuery): URLSearchParams => {
 6 |   const q = new URLSearchParams();
 7 |   if (!isUndefined(query.filters) && !isEmpty(query.filters)) {
 8 |     Object.keys(query.filters).forEach((filterId: string) => {
 9 |       return query.filters![filterId].forEach((id: string) => {
10 |         q.append(filterId, id.toString());
11 |       });
12 |     });
13 |   }
14 |   if (!isUndefined(query.ts_query_web) && query.ts_query_web !== '') {
15 |     q.set('ts_query_web', query.ts_query_web);
16 |   }
17 |   if (!isUndefined(query.time_range)) {
18 |     q.set('time_range', query.time_range);
19 |   }
20 |   if (!isUndefined(query.organization)) {
21 |     q.set('organization', query.organization);
22 |   }
23 |   return q;
24 | };
25 | 
26 | const prepareQueryString = (query: SearchFiltersURL): string => {
27 |   const q = getURLSearchParams(query);
28 |   q.set('page', query.pageNumber.toString());
29 |   return `?${q.toString()}`;
30 | };
31 | 
32 | export default prepareQueryString;
33 | 


--------------------------------------------------------------------------------
/web/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "noFallthroughCasesInSwitch": true,
16 |     "module": "esnext",
17 |     "moduleResolution": "node",
18 |     "resolveJsonModule": true,
19 |     "isolatedModules": true,
20 |     "noEmit": true,
21 |     "jsx": "react-jsx"
22 |   },
23 |   "include": [
24 |     "src"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------