ci-environment 10.0.1__tar.gz

ci-environment-10.0.1/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: ci-environment
+Version: 10.0.1
+Summary: This library detects the CI environment based on environment variables defined by CI servers.
+Author-email: Cucumber Limited <cukes@googlegroups.com>
+Maintainer-email: Konstantin Goloveshko <kostya.goloveshko@gmail.com>
+License: MIT
+Project-URL: Repository, https://github.com/cucumber/ci-environment
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: importlib_resources
+Requires-Dist: python-dotenv
+Provides-Extra: test
+Requires-Dist: tox; extra == "test"
+
+# CiEnvironment
+
+Python implementation of https://github.com/cucumber/ci-environment

ci-environment-10.0.1/README.md

@@ -0,0 +1,3 @@
+# CiEnvironment
+
+Python implementation of https://github.com/cucumber/ci-environment

ci-environment-10.0.1/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools", "wheel"]
+
+[project]
+authors = [
+  {name = "Cucumber Limited", email = "cukes@googlegroups.com"}
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: MacOS :: MacOS X",
+  "Topic :: Utilities",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11"
+]
+dependencies = [
+  "importlib_resources",
+  "python-dotenv"
+]
+dynamic = [
+  "optional-dependencies"
+]
+description = "This library detects the CI environment based on environment variables defined by CI servers."
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {text = "MIT"}
+maintainers = [
+  {name = "Konstantin Goloveshko", email = "kostya.goloveshko@gmail.com"}
+]
+name = "ci-environment"
+requires-python = ">=3.8"
+urls = {Repository = "https://github.com/cucumber/ci-environment"}
+version = "10.0.1"
+
+[project.entry-points]
+
+[project.scripts]
+
+[tool.black]
+line-length = 120
+target-version = ["py38", "py39", "py310", "py311"]
+verbose = true
+
+[tool.isort]
+line_length = 120
+multi_line_output = 3
+profile = "black"
+
+[tool.mypy]
+files = "src/ci_environment/**/*.py"
+install_types = true
+non_interactive = true
+plugins = [
+  "pydantic.mypy"
+]
+show_error_codes = true
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = [
+]

ci-environment-10.0.1/setup.cfg

@@ -0,0 +1,21 @@
+[options]
+include_package_data = True
+packages = find:
+package_dir = 
+	=src
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+ci_environment = 
+	CiEnvironments.json
+
+[options.extras_require]
+test = 
+	tox
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

ci-environment-10.0.1/src/ci_environment/CiEnvironments.json

@@ -0,0 +1,160 @@
+[
+  {
+    "name": "Azure Pipelines",
+    "url": "${BUILD_BUILDURI}",
+    "buildNumber": "${BUILD_BUILDNUMBER}",
+    "git": {
+      "remote": "${BUILD_REPOSITORY_URI}",
+      "revision": "${BUILD_SOURCEVERSION}",
+      "branch": "${BUILD_SOURCEBRANCH/refs\/heads\/(.*)/\\1}",
+      "tag": "${BUILD_SOURCEBRANCH/refs\/tags\/(.*)/\\1}"
+    }
+  },
+  {
+    "name": "Bamboo",
+    "url": "${bamboo_buildResultsUrl}",
+    "buildNumber": "${bamboo_buildNumber}",
+    "git": {
+      "remote": "${bamboo_planRepository_repositoryUrl}",
+      "revision": "${bamboo_planRepository_revision}",
+      "branch": "${bamboo_planRepository_branch}"
+    }
+  },
+  {
+    "name": "Buddy",
+    "url": "${BUDDY_EXECUTION_URL}",
+    "buildNumber": "${BUDDY_EXECUTION_ID}",
+    "git": {
+      "remote": "${BUDDY_SCM_URL}",
+      "revision": "${BUDDY_EXECUTION_REVISION}",
+      "branch": "${BUDDY_EXECUTION_BRANCH}",
+      "tag": "${BUDDY_EXECUTION_TAG}"
+    }
+  },
+  {
+    "name": "Bitrise",
+    "url": "${BITRISE_BUILD_URL}",
+    "buildNumber": "${BITRISE_BUILD_NUMBER}",
+    "git": {
+      "remote": "${GIT_REPOSITORY_URL}",
+      "revision": "${BITRISE_GIT_COMMIT}",
+      "branch": "${BITRISE_GIT_BRANCH}",
+      "tag": "${BITRISE_GIT_TAG}"
+    }
+  },
+  {
+    "name": "CircleCI",
+    "url": "${CIRCLE_BUILD_URL}",
+    "buildNumber": "${CIRCLE_BUILD_NUM}",
+    "git": {
+      "remote": "${CIRCLE_REPOSITORY_URL}",
+      "revision": "${CIRCLE_SHA1}",
+      "branch": "${CIRCLE_BRANCH}",
+      "tag": "${CIRCLE_TAG}"
+    }
+  },
+  {
+    "name": "CodeFresh",
+    "url": "${CF_BUILD_URL}",
+    "buildNumber": "${CF_BUILD_ID}",
+    "git": {
+      "remote": "${CF_COMMIT_URL/(.*)\\/commit.+$/\\1}.git",
+      "revision": "${CF_REVISION}",
+      "branch": "${CF_BRANCH}"
+    }
+  },
+  {
+    "name": "CodeShip",
+    "url": "${CI_BUILD_URL}",
+    "buildNumber": "${CI_BUILD_NUMBER}",
+    "git": {
+      "remote": "${CI_PULL_REQUEST/(.*)\\/pull\\/\\d+/\\1.git}",
+      "revision": "${CI_COMMIT_ID}",
+      "branch": "${CI_BRANCH}"
+    }
+  },
+  {
+    "name": "GitHub Actions",
+    "url": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}",
+    "buildNumber": "${GITHUB_RUN_ID}",
+    "git": {
+      "remote": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git",
+      "revision": "${GITHUB_SHA}",
+      "branch": "${GITHUB_HEAD_REF}",
+      "tag": "${GITHUB_REF/refs\/tags\/(.*)/\\1}"
+    }
+  },
+  {
+    "name": "GitLab",
+    "url": "${CI_JOB_URL}",
+    "buildNumber": "${CI_JOB_ID}",
+    "git": {
+      "remote": "${CI_REPOSITORY_URL}",
+      "revision": "${CI_COMMIT_SHA}",
+      "branch": "${CI_COMMIT_BRANCH}",
+      "tag": "${CI_COMMIT_TAG}"
+    }
+  },
+  {
+    "name": "GoCD",
+    "url": "${GO_SERVER_URL}/pipelines/${GO_PIPELINE_NAME}/${GO_PIPELINE_COUNTER}/${GO_STAGE_NAME}/${GO_STAGE_COUNTER}",
+    "buildNumber": "${GO_PIPELINE_NAME}/${GO_PIPELINE_COUNTER}/${GO_STAGE_NAME}/${GO_STAGE_COUNTER}",
+    "git": {
+      "remote": "${GO_SCM_*_PR_URL/(.*)\\/pull\\/\\d+/\\1.git}",
+      "revision": "${GO_REVISION}",
+      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}"
+    }
+  },
+  {
+    "name": "Jenkins",
+    "url": "${BUILD_URL}",
+    "buildNumber": "${BUILD_NUMBER}",
+    "git": {
+      "remote": "${GIT_URL}",
+      "revision": "${GIT_COMMIT}",
+      "branch": "${GIT_LOCAL_BRANCH}"
+    }
+  },
+  {
+    "name": "JetBrains Space",
+    "url": "${JB_SPACE_EXECUTION_URL}",
+    "buildNumber": "${JB_SPACE_EXECUTION_NUMBER}",
+    "git": {
+      "remote": "https://${JB_SPACE_API_URL}/p/${JB_SPACE_PROJECT_KEY}/repositories/${JB_SPACE_GIT_REPOSITORY_NAME}",
+      "revision": "${JB_SPACE_GIT_REVISION}",
+      "branch": "${JB_SPACE_GIT_BRANCH}"
+    }
+  },
+  {
+    "name": "Semaphore",
+    "url": "${SEMAPHORE_ORGANIZATION_URL}/jobs/${SEMAPHORE_JOB_ID}",
+    "buildNumber": "${SEMAPHORE_JOB_ID}",
+    "git": {
+      "remote": "${SEMAPHORE_GIT_URL}",
+      "revision": "${SEMAPHORE_GIT_SHA}",
+      "branch": "${SEMAPHORE_GIT_BRANCH}",
+      "tag": "${SEMAPHORE_GIT_TAG_NAME}"
+    }
+  },
+  {
+    "name": "Travis CI",
+    "url": "${TRAVIS_BUILD_WEB_URL}",
+    "buildNumber": "${TRAVIS_JOB_NUMBER}",
+    "git": {
+      "remote": "https://github.com/${TRAVIS_REPO_SLUG}.git",
+      "revision": "${TRAVIS_COMMIT}",
+      "branch": "${TRAVIS_BRANCH}",
+      "tag": "${TRAVIS_TAG}"
+    }
+  },
+  {
+    "name": "Wercker",
+    "url": "${WERCKER_RUN_URL}",
+    "buildNumber": "${WERCKER_RUN_URL/.*\\/([^\\/]+)$/\\1}",
+    "git": {
+      "remote": "https://${WERCKER_GIT_DOMAIN}/${WERCKER_GIT_OWNER}/${WERCKER_GIT_REPOSITORY}.git",
+      "revision": "${WERCKER_GIT_COMMIT}",
+      "branch": "${WERCKER_GIT_BRANCH}"
+    }
+  }
+]

ci-environment-10.0.1/src/ci_environment/__init__.py

@@ -0,0 +1,3 @@
+from ci_environment.ci_environment import detect_ci_environment
+
+__all__ = ["detect_ci_environment"]

ci-environment-10.0.1/src/ci_environment/ci_environment.py

@@ -0,0 +1,89 @@
+from collections import namedtuple
+from contextlib import suppress
+from functools import partial, wraps
+from itertools import filterfalse
+from json import loads as loads_json
+from operator import is_
+from pathlib import Path
+from pprint import pformat
+from typing import Dict
+from urllib.parse import urlparse
+
+from importlib_resources import as_file, files
+
+from ci_environment.variable_expression import evaluate
+
+_key_value = namedtuple("_key_value", ["key", "value"])
+
+
+@wraps(dict)
+def _opt_dict(*args, **kwargs) -> Dict:
+    return {k: v for k, v in dict(*args, **kwargs).items() if v is not None}
+
+
+def _flip(func):
+    def wrapped(*args, **kwargs):
+        if len(args) > 1:
+            first, *other, last = args
+            return func(last, *other, first, **kwargs)
+        else:
+            return func(*args, **kwargs)
+
+    return wrapped
+
+
+def detect_ci_environment(env: Dict[str, str]):
+    with as_file(files("ci_environment").joinpath("CiEnvironments.json")) as path:
+        ci_environments = loads_json(Path(path).read_text())
+
+    return next(filterfalse(partial(_flip(is_), None), map(partial(detect, env=env), ci_environments)), None)
+
+
+def detect(ci_environment, env: Dict[str, str]):
+    if (url := evaluate(ci_environment["url"], env)) is not None:
+        return dict(
+            name=ci_environment["name"],
+            url=url,
+            buildNumber=evaluate(ci_environment["buildNumber"], env),
+            **_opt_dict(git=detect_git(ci_environment, env)),
+        )
+
+
+def detect_git(ci_environment, env: Dict[str, str]):
+    if all(
+        [
+            (revision := detect_revision(ci_environment, env)) is not None,
+            (remote := evaluate(ci_environment["git"]["remote"], env)) is not None,
+        ]
+    ):
+        return dict(
+            remote=remove_userinfo_from_url(remote),
+            revision=revision,
+            **_opt_dict(
+                tag=evaluate(ci_environment.get("git", {}).get("tag"), env),
+                branch=evaluate(ci_environment.get("git", {}).get("branch"), env),
+            ),
+        )
+
+
+def detect_revision(ci_environment, env: Dict[str, str]):
+    if env.get("GITHUB_EVENT_NAME") == "pull_request":
+        try:
+            event = loads_json(Path(env["GITHUB_EVENT_PATH"]).read_text())
+        except KeyError as e:
+            raise ValueError from e
+        try:
+            revision = event["pull_request"]["head"]["sha"]
+        except KeyError as e:
+            raise ValueError(pformat(event)) from e
+        else:
+            return revision
+    else:
+        return evaluate(ci_environment["git"]["revision"], env)
+
+
+def remove_userinfo_from_url(remote):
+    if remote is not None:
+        with suppress(Exception):
+            return (parsed_url := urlparse(remote))._replace(netloc=parsed_url.hostname).geturl()
+        return remote

ci-environment-10.0.1/src/ci_environment/variable_expression.py

@@ -0,0 +1,43 @@
+from contextlib import suppress
+from re import compile as compile_re
+from re import subn
+from typing import Dict
+
+
+def evaluate(expression, env):
+    if expression is None:
+        return
+    with suppress(Exception):
+        re_pattern = compile_re(r"\$\{(.*?)(?:(?<!\\)/(.*)/(.*))?}")
+
+    def repl(match):
+        variable = match.group(1)
+        value = get_value(env, variable)
+        if value is None:
+            raise ValueError
+        pattern = match.group(2)
+        if pattern is None:
+            return value
+        regexp = compile_re(subn("\\/", "/", pattern)[0])
+
+        replacement = match.group(3)
+        if regexp.match(value):
+            return regexp.subn(replacement, value)[0]
+        else:
+            raise ValueError
+
+    try:
+        result = re_pattern.subn(repl=repl, string=expression)[0]
+        return result
+    except ValueError:
+        ...
+
+
+def get_value(env: Dict, variable: str):
+    if "*" in variable:
+        pattern = compile_re(variable.replace("*", ".*"))
+        for name, value in env.items():
+            if pattern.match(name):
+                return value
+    else:
+        return env.get(variable)

ci-environment-10.0.1/src/ci_environment.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: ci-environment
+Version: 10.0.1
+Summary: This library detects the CI environment based on environment variables defined by CI servers.
+Author-email: Cucumber Limited <cukes@googlegroups.com>
+Maintainer-email: Konstantin Goloveshko <kostya.goloveshko@gmail.com>
+License: MIT
+Project-URL: Repository, https://github.com/cucumber/ci-environment
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: importlib_resources
+Requires-Dist: python-dotenv
+Provides-Extra: test
+Requires-Dist: tox; extra == "test"
+
+# CiEnvironment
+
+Python implementation of https://github.com/cucumber/ci-environment

ci-environment-10.0.1/src/ci_environment.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+setup.cfg
+src/ci_environment/CiEnvironments.json
+src/ci_environment/__init__.py
+src/ci_environment/ci_environment.py
+src/ci_environment/variable_expression.py
+src/ci_environment.egg-info/PKG-INFO
+src/ci_environment.egg-info/SOURCES.txt
+src/ci_environment.egg-info/dependency_links.txt
+src/ci_environment.egg-info/requires.txt
+src/ci_environment.egg-info/top_level.txt
+tests/test_detect_ci_environment.py
+tests/test_variable_expression.py

ci-environment-10.0.1/src/ci_environment.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ci-environment-10.0.1/src/ci_environment.egg-info/requires.txt

@@ -0,0 +1,5 @@
+importlib_resources
+python-dotenv
+
+[test]
+tox

ci-environment-10.0.1/src/ci_environment.egg-info/top_level.txt

@@ -0,0 +1 @@
+ci_environment

ci-environment-10.0.1/tests/test_detect_ci_environment.py

@@ -0,0 +1,21 @@
+from json import loads
+from pathlib import Path
+
+from dotenv import dotenv_values
+from pytest import mark
+
+from ci_environment import detect_ci_environment
+
+_data_path = Path(__file__) / ".." / ".." / ".." / "testdata"
+
+
+@mark.parametrize("envfile", _data_path.glob("*.txt"))
+def test_detect_ci_environment(envfile):
+    env = dotenv_values(envfile)
+    expected = loads((envfile.resolve().parent / f"{envfile.name}.json").read_text())
+
+    assert detect_ci_environment(env) == expected
+
+
+def test_detect_ci_environment_when_no_environment():
+    assert detect_ci_environment({}) is None

ci-environment-10.0.1/tests/test_variable_expression.py

@@ -0,0 +1,42 @@
+from ci_environment.variable_expression import evaluate
+
+
+def test_evaluate_returns_undefined_when_a_variable_iws_undefined():
+    expression = "hello-${SOME_VAR}"
+    result = evaluate(expression, {})
+    assert result is None
+
+
+def test_evaluate_gets_a_value_without_replacement():
+    expression = "${SOME_VAR}"
+    result = evaluate(expression, {"SOME_VAR": "some_value"})
+    assert result == "some_value"
+
+
+def test_evaluate_captures_a_group():
+    expression = "${SOME_REF/refs\\/heads\\/(.*)/\\1}"
+    result = evaluate(expression, {"SOME_REF": "refs/heads/main"})
+    assert result == "main"
+
+
+def test_evaluate_works_with_star_wildcard_in_var():
+    expression = "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}"
+    result = evaluate(
+        expression,
+        {
+            "GO_SCM_MY_MATERIAL_PR_BRANCH": "ashwankthkumar:feature-1",
+        },
+    )
+    assert result == "feature-1"
+
+
+def test_evaluate_evaluates_a_complex_expression():
+    expression = "hello-${VAR1}-${VAR2/(.*) (.*)/\\2-\\1}-world"
+    result = evaluate(
+        expression,
+        {
+            "VAR1": "amazing",
+            "VAR2": "gorgeous beautiful",
+        },
+    )
+    assert result == "hello-amazing-beautiful-gorgeous-world"