Add Initial Codebase for Integrations CLI

.github/workflows/python-poetry.yml

@@ -0,0 +1,23 @@
+name: Python Poetry CI
+on: pull_request
+
+jobs:
+ ci:
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: ["3.10"]
+ poetry-version: ["1.0"]
+ os: [ubuntu-18.04, macos-latest, windows-latest]
+ runs-on: ${{ matrix.os }}
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Run image
+ uses: abatilo/actions-poetry@v2
+ with:
+ poetry-version: ${{ matrix.poetry-version }}
+ - name: Run Integrations CLI unit tests
+ run: cd scripts/integrations-cli && poetry install && poetry run python -m unittest

scripts/integrations-cli/.gitignore

@@ -0,0 +1,180 @@
+# Directories used by CLI
+artifacts
+integrations
+
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

scripts/integrations-cli/helpers/__init__.py

@@ -0,0 +1,3 @@
+from . import constants, validate
+from .catalog import CatalogManager
+from .create import IntegrationBuilder

scripts/integrations-cli/helpers/catalog.py

@@ -0,0 +1,22 @@
+import json
+import os
+from functools import cache
+
+from returns.io import impure_safe
+
+from . import constants, validate
+
+
+@impure_safe
+def _load_catalog_file() -> dict:
+ catalog_path = os.path.join(constants.SCHEMA_ROOT, "observability/catalog.json")
+ with open(catalog_path, "r", encoding="utf-8") as catalog_file:
+ return json.load(catalog_file)
+
+
+class CatalogManager:
+ @cache
+ def __init__(self):
+ catalog = _load_catalog_file().bind_result(validate.validate_catalog)
+ # For now just re-throw exceptions on catalog load failure
+ self.catalog = catalog.unwrap()._inner_value

scripts/integrations-cli/helpers/constants.py

@@ -0,0 +1,25 @@
+import glob
+import json
+import os
+
+SCHEMA_ROOT = "../../src/main/resources/schema"
+
+DEFAULT_CONFIG = {
+ "template-name": "default",
+ "version": {"integration": "0.1.0", "schema": "1.0.0", "resource": "^1.23.0"},
+ "description": "",
+ "identification": "",
+ "catalog": "observability",
+ "components": [],
+ "collection": [],
+ "repository": {"url": "https://example.com/"},
+}
+
+SCHEMAS = {}
+
+# For now, assume we're running in the current relative directory
+if os.path.isdir(SCHEMA_ROOT):
+ for filename in glob.glob(os.path.join(SCHEMA_ROOT, "**/*.schema"), recursive=True):
+ schema_name = os.path.split(filename)[1]
+ with open(filename, "r", encoding="utf-8") as schema_file:
+ SCHEMAS[schema_name] = json.load(schema_file)

scripts/integrations-cli/helpers/create.py

@@ -0,0 +1,61 @@
+import json
+import os
+import re
+from copy import deepcopy
+from urllib import parse
+
+from .constants import DEFAULT_CONFIG
+from .validate import validate_config
+
+
+class IntegrationBuilder:
+ def __init__(self):
+ self.path = None
+ self.config = deepcopy(DEFAULT_CONFIG)
+
+ def with_name(self, name: str) -> "IntegrationBuilder":
+ self.config["template-name"] = name
+ return self
+
+ def with_path(self, path: str) -> "IntegrationBuilder":
+ self.path = path
+ self.config["repository"]["url"] = f"file://{path}"
+ return self
+
+ def with_schema_version(self, version: str) -> "IntegrationBuilder":
+ if not re.match(r"^\d+\.\d+\.\d+", version):
+ raise ValueError("Invalid version")
+ self.config["version"]["schema"] = version
+ return self
+
+ def with_resource_version(self, version: str) -> "IntegrationBuilder":
+ if not re.match(r"^\^?\d+\.\d+\.\d+", version):
+ raise ValueError("Invalid version")
+ self.config["version"]["resource"] = version
+ return self
+
+ def with_description(self, desc: str) -> "IntegrationBuilder":
+ self.config["description"] = desc
+ return self
+
+ def with_catalog(self, catalog: str) -> "IntegrationBuilder":
+ self.config["catalog"] = catalog
+ return self
+
+ def with_repository(self, repo_url: str) -> "IntegrationBuilder":
+ if not parse.urlparse(repo_url, allow_fragments=False):
+ raise ValueError("Invalid URL")
+ self.config["repository"]["url"] = repo_url
+ return self
+
+ def with_component(self, component: dict) -> "IntegrationBuilder":
+ self.config["components"].append(component)
+ return self
+
+ def build(self):
+ assert self.path is not None
+ os.makedirs(self.path, exist_ok=True)
+ files = {"config.json": validate_config(self.config).unwrap()}
+ for filename, data in files.items():
+ with open(os.path.join(self.path, filename), "w", encoding="utf-8") as file:
+ json.dump(data, file, ensure_ascii=False, indent=2)

scripts/integrations-cli/helpers/validate.py

@@ -0,0 +1,29 @@
+import jsonschema
+from returns.result import Failure, Result, safe
+
+from .constants import SCHEMAS
+
+
+@safe(
+ exceptions=(
+ jsonschema.exceptions.ValidationError,
+ jsonschema.exceptions.SchemaError,
+ )
+)
+def validate_instance(instance: dict, schema: dict) -> dict:
+ jsonschema.validate(instance, schema)
+ return instance
+
+
+def validate_config(config: dict) -> Result[dict, Exception]:
+ try:
+ return validate_instance(config, SCHEMAS["integration.schema"])
+ except KeyError as err:
+ return Failure(err)
+
+
+def validate_catalog(catalog: dict) -> Result[dict, Exception]:
+ try:
+ return validate_instance(catalog, SCHEMAS["catalog.schema"])
+ except KeyError as err:
+ return Failure(err)