.dockerignore

+target

.editorconfig

+root = true
+[*]
+indent_style=tab
+indent_size=tab
+tab_width=4
+end_of_line=lf
+charset=utf-8
+trim_trailing_whitespace=true
+max_line_length=100
+insert_final_newline=true
+
+[*.md]
+max_line_length=80
+indent_style=space
+indent_size=2
+
+[*.yml]
+indent_style=space
+indent_size=2
+tab_width=8
+end_of_line=lf
+
+[*.sh]
+indent_style=space
+indent_size=2
+tab_width=8
+end_of_line=lf

.github/workflows/quick-check.yml

+# This workflow runs on every push and checks whether everything looks good
+
+name: Quick check
+
+on:
+  push:
+    tags:
+      - "!v*"
+    branches:
+      - "*"
+  pull_request:
+    types: [assigned, opened, synchronize, reopened]
+
+jobs:
+  quick_check:
+    strategy:
+      matrix:
+        os: ["ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Install Rust stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+          components: clippy, rustfmt
+
+      - name: Install Rust tooling
+        uses: taiki-e/install-action@v1
+        with:
+          tool: nextest
+
+      - name: Cache Dependencies & Build Outputs
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-${{ matrix.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - uses: actions/checkout@v2
+
+      - name: Cargo fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+      - name: Cargo clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: -- -D warnings
+
+      - name: Cargo nextest
+        uses: actions-rs/cargo@v1
+        with:
+          command: nextest
+          args: run
+
+      - name: Cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check

.gitignore

+/target
+.env
+specs.md

Cargo.toml

+[package]
+name = "ruled-labels"
+version = "0.3.1"
+edition = "2021"
+license-file = "LICENSE"
+
+[dependencies]
+clap = { version = "4", features = ["derive", "env", "unicode", "cargo", "color"] }
+env_logger = "0.9"
+futures = "0.3"
+hubcaps = "0.6"
+log = "0.4"
+serde = { version = "1.0", features = ["derive"] }
+serde_yaml = { version = "0.9", optional = false }
+termion = "1.5"
+semver = { version = "1.0", features = ["serde"] }
+regex = "1"
+anyhow = "1.0"
+
+[dev-dependencies]
+assert_cmd = "2.0"

Dockerfile

+FROM docker.io/paritytech/ci-linux:production as builder
+
+ARG PROFILE=release
+WORKDIR /app
+
+COPY . .
+
+RUN cargo build --${PROFILE} --bins
+
+# MAIN IMAGE FOR PEOPLE TO PULL --- small one#
+FROM docker.io/debian:buster-slim
+LABEL maintainer="Chevdor"
+
+ARG PROFILE=release
+ARG USER=ci
+WORKDIR /usr/local/bin
+
+COPY --from=builder /app/target/$PROFILE/ruled-labels /usr/local/bin
+
+RUN useradd -m -u 1000 -U $USER && \
+    apt-get -y update && \
+    apt-get -y install openssl && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/
+
+USER $USER
+ENTRYPOINT [ "ruled-labels" ]

LICENSE

+Copyright 2021-2022 - Wilfried Kopp aka. Chevdor <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+# Ruled Labels
+
+![badge](https://github.com/chevdor/ruled_labels/actions/workflows/quick-check.yml/badge.svg?branch=master)
+
+## Intro
+
+`ruled-labels` is compatible with the `glabel` yaml format and allow specifying additionnal rules regarding the labels. Those rules are described in a yaml file.
+
+`ruled-labels` can handle:
+
+-   the list of labels and their properties
+
+-   the label rules
+
+-   a description of test cases
+
+## Getting started
+
+Upon doing the [Install](#install), a new command called `ruled-labels` will be available on your system
+
+The minimum you will need is a [Rules](#specs) file. It is usually called `specs.yml` and `ruled-labels` will find it by default if you are using this name.
+
+Having your [Rules](#specs), you can call `ruled-labels` to check a set of labels. Here is how it looks like:
+
+    ruled-labels check --labels A1,B1
+
+Alternatively, you can also call:
+
+    ruled-labels check -l A1 -l B1
+
+The following calls are NOT valid:
+
+-   `ruled-labels check --labels A1, B1`
+
+-   `ruled-labels check --labels A1 B1`
+
+Check out the [Usage](#usage) to learn more about the available commands. and options.
+
+In most case, you will not call the check command manually, but let your CI take care of that.
+
+First, you may fetch the labels of your PR:
+
+    API_BASE=https://api.github.com/repos
+    REPO=...
+    GITHUB_PR=1234
+    labels=$( curl -H "Authorization: token $GITHUB_TOKEN" -s "$API_BASE/$REPO/pulls/$GITHUB_PR" | jq '.labels | .[] | .name' | tr "\n" ",")
+
+You can now remove the leading `,` that is not useful:
+
+    labels_args=${labels: :-1}
+
+And finally run the check:
+
+    ruled-labels check --dev --labels $labels_args
+
+If you prefer using a docker image, here is how it looks like:
+
+    docker run --rm -i -e labels_args -v $PWD/:$MOUNT $IMAGE check $MOUNT/$CHECK_SPECS --dev --labels $labels_args
+
+## Install
+
+There is currenly no binary package so you need to use `cargo` to build and install `ruled-labels` on your system.
+
+    cargo install --locked --git https://github.com/chevdor/ruled_labels
+
+## Docker
+
+If you prefer not having to install Rust & Cargo and have Docker installed, you may prefer to run a dockerized version of `ruled-labels`. The next chapters explain how to proceed.
+
+### Run
+
+Docker commands can end up quite lenghty so you may like to set an alias:
+
+        alias ruled-labels='docker run --rm -it ruled-labels'
+
+After setting this alias, you may use `ruled-labels` by simply invoking the `ruled-labels` command:
+
+        ruled-labels --version
+
+If you prefer a shorter a command, you may set an alias for `rl` instead of `ruled-labels`.
+
+This is out of the scope of this documentation but note that you cannot just invoke `ruled-labels` check and expect it to work on your local `specs.yaml`. For that to work, you need to mount your `specs.yaml` into the container. That looks like this:
+
+        docker run --rm -it -v $PWD/specs.yaml:/usr/local/bin/specs.yaml <literal>ruled-labels</literal> list
+
+### Build
+
+You can pull the docker image from `chevdor`/`ruled-labels` or build you own:
+
+        docker build -t ruled-labels .
+
+## Features
+
+-   rule based engine
+
+-   rules defined as yaml
+
+-   `lint`: the lint command helps you validate your yaml files
+
+-   `list`: show a summary of your rules
+
+-   `test`: You can define a set of tests scenarii to check against your specs to ensure you did not leave anything behind
+
+-   `check`: CI can call this command to check a set of labels against your specs & rules
+
+# Usage
+
+## Help
+
+    ruled-labels 0.2.0
+
+    This utility allows checking labels based on rules
+
+    USAGE:
+        ruled-labels [OPTIONS] <SUBCOMMAND>
+
+    OPTIONS:
+        -d, --dev         The output is more developer oriented
+        -h, --help        Print help information
+            --no-color    Output without any coloring, this is useful for documentation and CI system
+                          where the color code pollute the output
+        -V, --version     Print version information
+
+    SUBCOMMANDS:
+        check    Check label set against the rules
+        help     Print this message or the help of the given subcommand(s)
+        lint     Lint the rules
+        list     List all the rules
+        test     Run tests using rules and a test set
+
+## Lint
+
+    PASSED  The file specs.yaml looks OK
+
+## List
+
+    name: chevdor/glabel
+    desc: Import from chevdor/glabel
+    labels: 14
+    Rules:
+     - Some topics (X labels)
+     - Exactly one visibility label (b_rules)
+     - Note Worthy need one Prio label (b_need_p)
+     - Note Worthy implies no J label (b_excludes_j)
+     - Exclude all Ds
+     - Require all of J
+     - Require 1 P and no X
+
+## Test
+
+    Tests specs: tests.yaml
+    Specs file : specs.yaml
+
+        ▶️ Running test  1: Fail
+    You need to include one of the B* label(s)
+    You need to include all of the J* label(s)
+    You need to include one of the P* label(s) and you need to exclude all of the X2, X1 label(s)
+        PASSED  Fail
+
+        ▶️ Running test  2: Pass
+    Since you have one of the B* label(s), you need to include one of the P* label(s) and you need to exclude all of the P1 label(s)
+    You need to include all of the J* label(s)
+    You need to include one of the P* label(s) and you need to exclude all of the X2, X1 label(s)
+        FAILED  Pass
+
+        ▶️ Running test  3: Missing topics
+    You need to include some of the X1, X2, J2 label(s)
+    Since you have one of the B* label(s), you need to include one of the P* label(s) and you need to exclude all of the P1 label(s)
+    You need to include all of the J* label(s)
+    You need to include one of the P* label(s) and you need to exclude all of the X2, X1 label(s)
+        PASSED  Missing topics
+
+        ▶️ Running test  4: Fail
+    You need to include some of the X1, X2, J2 label(s)
+    Since you have one of the B* label(s), you need to include one of the P* label(s) and you need to exclude all of the P1 label(s)
+    You need to include all of the J* label(s)
+    You need to include one of the P* label(s) and you need to exclude all of the X2, X1 label(s)
+        PASSED  Fail
+    FAILED  Some expectations were not OK
+
+## Check
+
+            FAILED  Some topics (X labels) | You need to include some of the J2, X1, X2 label(s)
+            PASSED  Exactly one visibility label | You need to include one of the B* label(s)
+            FAILED  Note Worthy need one Prio label | Since you have one of the B* label(s), you need to include one of the P* label(s) and you need to exclude all of the P1 label(s)
+            PASSED  Note Worthy implies no J label | You need to exclude all of the T* label(s)
+            PASSED  Exclude all Ds | You need to exclude all of the D* label(s)
+            FAILED  Require all of J | You need to include all of the J* label(s)
+            FAILED  Require 1 P and no X | You need to include one of the P* label(s) and you need to exclude all of the X1, X2 label(s)
+    FAILED  chevdor/glabel v0.1.0 for labels A1, B0
+
+## Vscode yaml
+
+Add to the [yaml pluggin](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (by RedHat) config:
+
+    "yaml.customTags": [
+        "!none_of sequence",
+        "!one_of sequence",
+        "!some_of sequence",
+        "!all_of sequence",
+    ]
+
+## Yaml specs
+
+## Rules
+
+    ---
+    # tag::header[]
+    name: chevdor/glabel
+    version: 0.1.0
+    description: Import from chevdor/glabel
+    # end::header[]
+
+    # tag::labels[]
+    labels:
+      - name: A1-foo
+        description: Foo
+        color: d73a4a
+      - name: A2-bar
+        description: Bar
+        color: d73a4a
+    # end::labels[]
+      - name: X1-frontend
+        description: Frontend
+        color: d73a4a
+      - name: X2-backend
+        description: Frontend
+        color: d73a4a
+      - name: X3-documentation
+        description: Improvements or additions to documentation
+        color: 0075ca
+      - name: P1-low_prio
+        description: Low prio
+        color: ffffff
+      - name: P2-low_prio
+        description: Low prio
+        color: ffffff
+      - name: P3-low_prio
+        description: Low prio
+        color: ffffff
+      - name: B0-silent
+        description: silent
+        color: ffffff
+      - name: B1-note_worthy
+        description: note worthy
+        color: ffffff
+      - name: B2-important
+        description: important
+        color: ffffff
+      - name: J1-junk1
+        description: junk1
+        color: ffffff
+      - name: J2-junk2
+        description: junk2
+        color: ffffff
+      - name: D1-disable1
+        description: diable1
+        color: ffffff
+
+    # tag::rules[]
+    rules:
+      - name: Some topics (X labels)
+        id: some_topics
+        spec:
+          require: !some_of
+            - X1
+            - X2
+            - J2
+    # end::rules[]
+
+      - name: Exactly one visibility label
+        id: b_rules
+        tags: [ CI ]
+        priority: 1000
+        description: |
+          This rule ensures we have a single visibility label.
+          It is important to void conflicts such as having a PR
+          labels as both important and unsubstantial.
+        spec:
+          require: !one_of
+            - B*
+          exclude: ~
+
+
+      - name: Note Worthy need one Prio label
+        id: b_need_p
+        tags: [v2, CI]
+        priority: 100
+        spec:
+          # when we have one of the B labels
+          when: !one_of
+            - B*
+          # we need exactly one of the P labels
+          require: !one_of
+            - P*
+          # but we don't want the P1 labels
+          exclude: !all_of
+            - P1
+
+      - name: Note Worthy implies no J label
+        id: b1_excludes_j
+        spec:
+          when: !one_of
+            - B1
+          exclude: !all_of
+            - J*
+
+      - name: Exclude all Ds
+        id: exclude_all_d
+        disabled: false   # default
+        priority: 100     # default
+        spec:
+          exclude: !all_of
+            - D*
+
+      - name: Require all of J
+        ide: require_all_j
+        spec:
+          require: !all_of
+            - J*
+
+      - name: Require 1 P and no X
+        id: single_p_no_x
+        disabled: true
+        spec:
+          require: !one_of
+            - P*
+          exclude: !all_of ["X1", "X2"]
+
+## Test
+
+    name: Name of the test
+    spec_file: specs.yaml
+
+    specs:
+      - name: Pass
+        only: true
+        labels:
+          - B0-silent
+          - X1-bar
+          - X2-bar
+          - X3-foobar
+          - J1
+          - J2
+          - P2
+        expected: true
+
+      - name: Fail - b_rules
+        filter:
+          id: [ b_rules ]
+        labels:
+          - B1-note_worthy
+          - B0-silent
+        expected: false
+
+      - name: Fail - some_topics
+        filter:
+          id: [ some_topics ]
+        skip: true
+        labels:
+          - B0-silent
+        expected: false
+
+      - name: Fail - b_need_p
+        filter:
+          id: [ b_need_p ]
+        labels:
+          - B1
+        expected: false
+
+      - name: Fail - b1_excludes_j
+        filter:
+          id: [ b1_excludes_j ]
+        labels:
+          - B1
+          - J1
+          - J2
+        expected: false
+
+      - name: Fail - b1_excludes_j 2
+        filter:
+          id: [ b1_excludes_j ]
+        labels:
+          - B1
+          - J1
+        expected: false
+
+## Glossary
+
+In order to understand the terminology and what are `LabelMatch`, `LabelMatchSet`, `Labels`, `LabelId`, etc…​ please refer to the Rust documenation. You can generate and open it using:
+
+    cargo doc --no-deps --open
+
+## Licence
+
+    Copyright 2021-2022 - Wilfried Kopp aka. Chevdor <[email protected]>
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README_src.adoc

+:toc: right
+:prj: ruled-labels
+:cli: pass:q[`ruled-labels`]
+:repo: https://github.com/chevdor/ruled_labels
+
+= Ruled Labels
+
+image::https://github.com/chevdor/ruled_labels/actions/workflows/quick-check.yml/badge.svg?branch=master[link="https://github.com/chevdor/ruled_labels/actions/workflows/quick-check.yml"]
+
+include::doc/index.adoc[]
+
+== Licence
+
+----
+include::LICENSE[]
+----

TODO.adoc

+== TODOS
+
+// tag::todo[]
+[.column]
+- testing! testing! testing!
+- code cleanup
+- Release ci
+
+[.column]
+- Support for `Option<Tag>` for `check`
+- Support for weight/priority ?
+// end::todo[]
+
+=== Done
+- regex on tests
+- improve `check` hints
+- Add a damn license :)
+- [x] get check to work
+- [x] deal with all todos
+- [x] get test to pass
+- [x] add tera template
+- [x] add an option to have a decription in the rules, for the doc
+- [x] Sets real Sets and not Vec, in order to avoid dups

doc/docker.adoc

+
+== Docker
+
+If you prefer not having to install Rust & Cargo and have Docker installed, you may prefer to run a dockerized version of {cli}. The next chapters explain how to proceed.
+
+=== Run
+
+Docker commands can end up quite lenghty so you may like to set an alias:
+
+[subs="attributes+"]
+----
+    alias {prj}='docker run --rm -it {prj}'
+----
+
+After setting this alias, you may use {cli} by simply invoking the {cli} command:
+
+[subs="attributes+"]
+----
+    {prj} --version
+----
+
+NOTE: If you prefer a shorter a command, you may set an alias for `rl` instead of {cli}.
+
+This is out of the scope of this documentation but note that you cannot just invoke {cli} check and expect it to work on your local `specs.yaml`. For that to work, you need to mount your `specs.yaml` into the container. That looks like this:
+
+[subs="attributes+"]
+----
+    docker run --rm -it -v $PWD/specs.yaml:/usr/local/bin/specs.yaml {cli} list
+----
+
+=== Build
+
+You can pull the docker image from `chevdor`/{cli} or build you own:
+
+[subs="attributes+"]
+----
+    docker build -t {prj} .
+----

doc/features.adoc

+
+== Features
+
+- rule based engine
+- rules defined as yaml
+- `lint`: the lint command helps you validate your yaml files
+- `list`: show a summary of your rules
+- `test`: You can define a set of tests scenarii to check against your specs to ensure you did not leave anything behind
+- `check`: CI can call this command to check a set of labels against your specs & rules

doc/getting-started.adoc

+:rl: pass:q[`ruled-labels`]
+
+== Getting started
+
+Upon doing the <<install>>, a new command called {rl} will be available on your system
+
+The minimum you will need is a <<specs>> file. It is usually called `specs.yml` and {rl} will find it by default if you are using this name.
+
+Having your <<specs>>, you can call {rl} to check a set of labels. Here is how it looks like:
+
+    ruled-labels check --labels A1,B1
+
+Alternatively, you can also call:
+
+    ruled-labels check -l A1 -l B1
+
+The following calls are NOT valid:
+
+- `ruled-labels check --labels A1, B1`
+- `ruled-labels check --labels A1 B1`
+
+Check out the <<usage>> to learn more about the available commands. and options.
+
+In most case, you will not call the check command manually, but let your CI take care of that.
+
+First, you may fetch the labels of your PR:
+
+    API_BASE=https://api.github.com/repos
+    REPO=...
+    GITHUB_PR=1234
+    labels=$( curl -H "Authorization: token $GITHUB_TOKEN" -s "$API_BASE/$REPO/pulls/$GITHUB_PR" | jq '.labels | .[] | .name' | tr "\n" ",")
+
+You can now remove the leading `,` that is not useful:
+
+    labels_args=${labels: :-1}
+
+And finally run the check:
+
+    ruled-labels check --dev --labels $labels_args
+
+If you prefer using a docker image, here is how it looks like:
+
+    docker run --rm -i -e labels_args -v $PWD/:$MOUNT $IMAGE check $MOUNT/$CHECK_SPECS --dev --labels $labels_args

doc/glossary.adoc

+
+== Glossary
+
+In order to understand the terminology and what are `LabelMatch`, `LabelMatchSet`, `Labels`, `LabelId`, etc... please refer to the Rust documenation. You can generate and open it using:
+
+    cargo doc --no-deps --open

doc/index.adoc

+
+include::intro.adoc[]
+
+include::getting-started.adoc[]
+
+include::install.adoc[]
+
+include::docker.adoc[]
+
+include::features.adoc[]
+
+include::usage/usage.adoc[leveloffset=+1]
+
+include::vscode_yaml.adoc[]
+
+== Yaml specs
+
+include::rules_yaml.adoc[leveloffset=+1]
+
+include::tests_yaml.adoc[leveloffset=+1]
+
+include::glossary.adoc[]

doc/install.adoc

+
+[[install]]
+== Install
+
+NOTE: There is currenly no binary package so you need to use `cargo` to build and install {cli} on your system.
+
+[subs="attributes+"]
+----
+cargo install --locked --git {repo}
+----

doc/intro.adoc

+
+== Intro
+
+{cli} is compatible with the `glabel` yaml format and allow specifying additionnal rules regarding the labels. Those rules are described in a yaml file.
+
+{cli} can handle:
+
+- the list of labels and their properties
+- the label rules
+- a description of test cases

doc/rules_yaml.adoc

+
+[[specs]]
+== Rules
+
+[source,yaml]
+----
+include::../specs.yaml[]
+----

doc/slides/.gitignore

+reveal.js
+.bundle
+*.html
\ No newline at end of file