Add CI files

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,30 @@
+---
+name: 🐛 Bug Report
+description: Create a report to help us improve Nornir Infrahub
+title: 'bug: '
+labels: ["type/bug"]
+body:
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A clear description of what the bug is and how it manifests.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Please explain the steps required to duplicate this issue.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: |
+        List any other information that is relevant to your request.
+        Stack traces, related issues, suggestions on how to implement, Stack Overflow links, forum links, etc.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,24 @@
+---
+name: 💡 Feature Request
+description: Suggest a feature for Nornir Infrahub
+title: 'feature: '
+labels: ["type/feature"]
+body:
+  - type: textarea
+    attributes:
+      label: Describe the Feature Request
+      description: A clear and concise description of what the feature does.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the Use Case
+      description: A clear and concise use case for what problem this feature would solve.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: |
+        List any other information that is relevant to your request.
+        Stack traces, related issues, suggestions on how to implement, Stack Overflow links, forum links, etc.

.github/ISSUE_TEMPLATE/task.yml

@@ -0,0 +1,12 @@
+---
+name: ✅ Task
+description: Create a task for minor issues that isn't a feature or a bug
+title: 'task: '
+labels: ["type/task"]
+body:
+  - type: textarea
+    attributes:
+      label: Task Description
+      description: A clear description of what it is you think should be done.
+    validations:
+      required: true

.github/labels.yml

@@ -0,0 +1,92 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+# ----------------------------------
+# TYPE (default)
+# ----------------------------------
+- name: "type/feature"
+  description: "New feature or request"
+  color: "a2eeef"
+
+- name: "type/bug"
+  description: "Something isn't working as expected"
+  color: "d73a4a"
+
+- name: "type/housekeeping"
+  description: "Maintenance task"
+  color: "fef2c0"
+
+# ----------------------------------
+# TYPE ALL
+# ----------------------------------
+- name: "type/question"
+  description: "Question or discussion"
+  color: "d876e3"
+
+- name: "type/documentation"
+  description: "Improvements or additions to documentation"
+  color: "0075ca"
+
+- name: "type/duplicate"
+  description: "This issue or pull request already exists"
+  color: "cfd3d7"
+
+- name: "type/epic"
+  description: "Large body of work composed of multiple tasks and/or features"
+  color: "fbd39c"
+
+- name: "type/task"
+  description: "Body of work related to an epic"
+  color: "0b8e92"
+
+- name: "type/brainstorming"
+  description: "Topic for brainstorming, discussions"
+  color: "e19e0f"
+
+- name: "type/user-centric"
+  description: "Issue that would improve the overall experience of our users"
+  color: "ff8c00"
+
+- name: "type/newcomers"
+  description: "Good for newcomers"
+  color: "309c56"
+
+# ----------------------------------
+# EFFORT
+# ----------------------------------
+- name: "effort/high"
+  description: "This issue should be completed in more than a day"
+  color: "c80464"
+
+- name: "effort/medium"
+  description: "This issue should be completed in a less than a day"
+  color: "676a43"
+
+- name: "effort/low"
+  description: "This issue should be completed in a couple of hours"
+  color: "eafee4"
+
+# ----------------------------------
+# STATUS
+# ----------------------------------
+- name: "state/blocked"
+  description: "The issue is currently blocked and cannot be resolved."
+  color: "e34918"
+
+- name: "state/draft"
+  description: "The redaction of the issue is still a work in progress"
+  color: "dcb518"
+
+- name: "state/referenced"
+  description: "This issue is referenced in our internal tooling"
+  color: "c9510c"
+
+# ----------------------------------
+# CI
+# ----------------------------------
+- name: "ci/skip-changelog"
+  description: "Don't include this PR in the changelog"
+  color: "c30664"

.github/release-note.yml

@@ -0,0 +1,31 @@
+---
+# name-template: 'v$RESOLVED_VERSION'
+# tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'type/feature'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'type/bug'
+  - title: '🧰 Maintenance'
+    label: 'type/housekeeping'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+exclude-labels:
+  - 'ci/skip-changelog'
+change-title-escapes: '\<*_&'  # You can add # and @ to disable mentions, and add ` to disable code blocks.
+# version-resolver:
+#   major:
+#     labels:
+#       - 'major'
+#   minor:
+#     labels:
+#       - 'minor'
+#   patch:
+#     labels:
+#       - 'patch'
+#   default: patch
+template: |
+  ## Changes
+
+  $CHANGES

.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+---
+# yamllint disable rule:truthy rule:truthy rule:line-length
+name: "CI"
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+      - stable
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 5
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v3"
+      - name: "Setup environment"
+        run: |
+          pipx install poetry
+          pip install invoke toml
+      - name: "Install Linters"
+        run: "poetry install --only=dev"
+      - name: "Linting"
+        run: "poetry run invoke lint"
+
+  python-tests:
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    if: |
+      always() && !cancelled() &&
+      !contains(needs.*.result, 'failure') &&
+      !contains(needs.*.result, 'cancelled')
+    needs: ["lint"]
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 30
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v3"
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: "Setup environment"
+        run: |
+          pipx install poetry
+          pip install invoke toml
+      - name: "Install Nornir Infrahub"
+        run: "poetry install"
+      - name: "Pytest Tests"
+        run: "poetry run pytest -v tests/"
+
+  # coverall-report:
+  #   needs: ["python-tests"]
+  #   if: |
+  #     always() && !cancelled()
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 10
+  #   steps:
+  #     - uses: coverallsapp/github-action@v2
+  #       env:
+  #         COVERALLS_SERVICE_NUMBER: ${{ github.sha }}
+  #       with:
+  #         carryforward: "nornir-unit"
+  #         parallel-finished: true

.github/workflows/labels.yml

@@ -0,0 +1,29 @@
+---
+# yamllint disable rule:truthy
+name: github
+
+on:
+  push:
+    branches:
+      - "develop"
+      - "stable"
+    paths:
+      - ".github/labels.yml"
+      - ".github/workflows/labels.yml"
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Run Labeler
+        uses: crazy-max/ghaction-github-labeler@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          yaml-file: .github/labels.yml
+          # exclude: |
+          #   help*
+          #   *issue

.gitignore

@@ -17,3 +17,4 @@ development/docker-compose.override.yml
 
 .dir-locals.el
 
+dist/*

.yamllint.yml

@@ -0,0 +1,14 @@
+---
+extends: default
+
+ignore: |
+  /.venv
+  /examples
+
+rules:
+  new-lines: disable
+  comments-indentation: disable
+  line-length:
+    max: 120
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: false

examples/nornir_inventory.py

@@ -12,9 +12,7 @@ def main():
                 "address": "http://localhost:8000",
                 "token": "06438eb2-8019-4776-878c-0941b1f1d1ec",
                 # defines the Infrahub Node kind that will mapped to Nornir Hosts
-                "host_node": {
-                    "kind": "InfraDevice"
-                },
+                "host_node": {"kind": "InfraDevice"},
                 # maps a Nornir Host property to an InfraNode attributes or relation
                 # name is the name of the Nornir Host property we want to map
                 # mapping is the attribute or relation of the Node from which we have to extract the value
@@ -30,10 +28,8 @@ def main():
                 ],
                 # create Nornir groups from InfraNode attributesor relations
                 # groups is created as attribute__value `site__jfk1`
-                "group_mappings": [
-                    "site.name"
-                ],
-                "group_file": "dummy.yml"
+                "group_mappings": ["site.name"],
+                "group_file": "dummy.yml",
             },
         }
     )

examples/nornir_tasks.py

@@ -68,5 +68,6 @@ def main():
 
     return 0
 
+
 if __name__ == "__main__":
     raise SystemExit(main())

nornir_infrahub/plugins/inventory/infrahub.py

@@ -132,7 +132,7 @@ class InfrahubInventory:
         group_file: Path to group file (defaults to ``group.yaml``)
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         host_node: Dict[str, Any],
         address: str = "http://localhost:8000",
@@ -169,7 +169,7 @@ def __init__(
         )
         self.extra_nodes = get_related_nodes(host_node_schema, attrs)
 
-    def load(self) -> Inventory:
+    def load(self) -> Inventory:  # noqa: PLR0912
         yml = ruamel.yaml.YAML(typ="safe")
 
         hosts = Hosts()