Ruled Labels

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, a new command called ruled-labels will be available on your system

The minimum you will need is a Rules file. It is usually called specs.yml and ruled-labels will find it by default if you are using this name.

Having your Rules, 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 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}

Before using the labels_args, you want to ensure you are using IFS="," so your shell does not split one label containing a space into 2 strings made of a valid label and one that will fail.

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

This utility allows checking labels based on rules

Usage: ruled-labels [OPTIONS] <COMMAND>

Commands:
  list   List all the rules
  lint   Lint the rules
  check  Check label set against the rules
  test   Run tests using rules and a test set
  help   Print this message or the help of the given subcommand(s)

Options:
      --no-color  Output without any coloring, this is useful for documentation and CI system where the color code pollute the output
  -d, --dev       The output is more developer oriented
  -h, --help      Print help information
  -V, --version   Print version information

Lint

PASSED  The file specs.yaml looks OK

List

name: chevdor/glabel
desc: Import from chevdor/glabel
labels: 14
Rules:
 - Some topics (X labels) (some_topics)
 - Exactly one visibility label (b_rules)
 - Note Worthy need one Prio label (b_need_p)
 - Note Worthy implies no J label (b1_excludes_j)
 - Exclude all Ds (exclude_all_d)
 - Require all of J
 - Require 1 P and no X (single_p_no_x) DISABLED

Test

Tests specs: tests.yaml
Specs file : specs.yaml

    ▶️ Running test  1: Pass
    PASSED  Pass

    ▶️ Running test  2: Fail - b_rules
You need to include one of the B* label(s)
    PASSED  Fail - b_rules

    ▶️ Running test  3: Fail - some_topics
You need to include some of the J2, X1, X2 label(s)
    PASSED  Fail - some_topics

    ▶️ Running test  4: Fail - b_need_p
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  Fail - b_need_p

    ▶️ Running test  5: Fail - b1_excludes_j
Since you have one of the B1 label(s), you need to exclude all of the J* label(s)
    PASSED  Fail - b1_excludes_j

    ▶️ Running test  6: Fail - b1_excludes_j 2
Since you have one of the B1 label(s), you need to exclude all of the J* label(s)
    PASSED  Fail - b1_excludes_j 2
PASSED  All expectations are OK

Check

s = "B0"
s = "A1"
        FAILED  Some topics (X labels) | You need to include some of the X2, J2, X1 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)
        SKIPPED Note Worthy implies no J label | Since you have one of the B1 label(s), you need to exclude all of the J* 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)
        SKIPPED 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 (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 <chevdor@gmail.com>

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.