ci cd

.github/workflows/ci-cd.yml

@@ -0,0 +1,23 @@
+name: CI/CD
+
+on:
+  push:
+
+jobs:
+  build:
+    name: Test and Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v3
+      - name: "Setup Python, Poetry and Dependencies"
+        uses: packetcoders/action-setup-cache-python-poetry@main
+        with:
+          python-version: 3.12
+          poetry-version: 1.8
+      - name: Run tests
+        run: |
+          poetry run pytest
+      - name: Build
+        run: |
+          poetry build

README.rst

@@ -70,6 +70,14 @@ It can be a local file or a file stored somewhere, e.g. git repository.
 Running the Pipeline
 --------------------
 
-If the pipeline configuration is stored locally, run `pype --local config.yml`.
+If the pipeline configuration is stored locally, run:
 
-If it is stored in a repository, run `pype --source github --repository gaarutyunov/pype --filename examples/config.yml --ref main`.
+.. code:: bash
+
+    pype --local config.yml
+
+If it is stored in a repository, run:
+
+.. code:: bash
+
+    pype --source github --repository gaarutyunov/pype --file examples/config.yml --ref main

examples/logger/__init__.py

@@ -1,2 +1,2 @@
 from .strategy import LoggerStrategy
-from .commands import Echo
+from .commands import Echo

examples/logger/commands.py

@@ -2,6 +2,7 @@
 
 from pype import Command
 
+
 class Echo(Command):
     logger: logging.Logger | None = None
 
@@ -11,4 +12,4 @@ def __init__(self, log_level: str = "ERROR"):
 
     def configure(self, **kwargs: str):
         self.logger = logging.getLogger(self.name)
-        self.logger.setLevel(self.log_level)
+        self.logger.setLevel(self.log_level)

examples/logger/strategy.py

@@ -7,4 +7,4 @@ def configure_echo(self, cmd: Echo, **kwargs: dict[str, str]):
         cmd.log_level = "INFO"
 
     def echo(self, cmd: Echo, params: dict[str, str]):
-        cmd.logger.info(params["MESSAGE"])
+        cmd.logger.info(params["MESSAGE"])

pype/__main__.py

@@ -1,5 +1,3 @@
-import pype.gitlab  # noqa: import for side effects
-import pype.github  # noqa: import for side effects
 from pype.cli import cli
 
 if __name__ == "__main__":

pype/cli.py

@@ -4,14 +4,19 @@
 import click
 import yaml
 
+import pype.gitlab  # noqa: import for side effects
+import pype.github  # noqa: import for side effects
+
 from pype import Pipeline
 from pype.registry import REGISTRY
 from pype.vcs import get_factory, RepositoryFileClient
 
 
 @click.command()
 @click.option("-s", "--source", help="Configuration remote source")
-@click.option("-l", "--local", type=click.File(lazy=True), help="Path to local configuration file")
+@click.option(
+    "-l", "--local", type=click.File(lazy=True), help="Path to local configuration file"
+)
 @click.option("-p", "--repository", type=str, help="Repository full name")
 @click.option("-r", "--ref", type=str, help="Reference (branch or tag)")
 @click.option("-f", "--file", type=str, help="Config file name")

pype/core/command.py

@@ -1,5 +1,6 @@
 class Command:
     """Command to be executed"""
+
     def __init__(self, name: str):
         """
         :param name: name of the command (is used to get method from Strategy)

pype/core/pipeline.py

@@ -6,6 +6,7 @@
 
 class Pipeline:
     """Entrypoint for the pipeline to be executed"""
+
     def __init__(self, stages: list[Stage]):
         """
         :param stages: list of stages to be run inside pipeline

pype/core/stage.py

@@ -6,6 +6,7 @@
 
 class Stage:
     """A list of commands to be handled by a Strategy one by one"""
+
     def __init__(self, name: str, strategy: Strategy, commands: list[Command]):
         """
         :param name: Name of the stage

pype/core/strategy.py

@@ -5,6 +5,7 @@
 
 class Strategy:
     """Class that implements commands handlers"""
+
     def run(self, command: Command, params: dict[str, str]):
         if hasattr(self, command.name):
             getattr(self, command.name)(command, params)

pype/github/vcs_adapter.py

@@ -4,16 +4,23 @@
 from github import Github, Auth
 from github.Consts import DEFAULT_BASE_URL
 
-from pype.vcs import VCSAdapter
+from pype.vcs import VCSAdapter, register_factory
 
 
+@register_factory("github")
 def github_factory() -> VCSAdapter:
-    return GithubAdapter(os.environ.get("GITHUB_TOKEN"), os.environ.get("GITHUB_URL", DEFAULT_BASE_URL))
+    return GithubAdapter(
+        os.environ.get("GITHUB_TOKEN"), os.environ.get("GITHUB_URL", DEFAULT_BASE_URL)
+    )
 
 
 class GithubAdapter:
     def __init__(self, token: str, url: str = DEFAULT_BASE_URL):
         self.client = Github(auth=Auth.Token(token), base_url=url)
 
     def download(self, repository: str, filename: str, ref: str) -> io.TextIOBase:
-        return io.StringIO(self.client.get_repo(repository).get_contents(filename, ref=ref).decoded_content.decode('utf-8'))
+        return io.StringIO(
+            self.client.get_repo(repository)
+            .get_contents(filename, ref=ref)
+            .decoded_content.decode("utf-8")
+        )

pype/gitlab/vcs_adapter.py

@@ -16,4 +16,9 @@ def __init__(self, url: str, token: str):
         self.client = Gitlab(url, token)
 
     def download(self, repository: str, filename: str, ref: str) -> io.TextIOBase:
-        return io.StringIO(self.client.projects.get(repository).files.get(filename, ref=ref).decode().decode("utf-8"))
+        return io.StringIO(
+            self.client.projects.get(repository)
+            .files.get(filename, ref=ref)
+            .decode()
+            .decode("utf-8")
+        )

pype/vcs/factory.py

@@ -4,6 +4,7 @@
 
 FACTORIES = {}
 
+
 def register_factory(name):
     def register(factory: Callable[[], VCSAdapter]):
         FACTORIES[name] = factory

pype/vcs/protocols.py

@@ -3,8 +3,7 @@
 
 
 class RepositoryFileClient(Protocol):
-    def download(self, repository: str, filename: str, ref: str) -> io.TextIOBase:
-        ...
+    def download(self, repository: str, filename: str, ref: str) -> io.TextIOBase: ...
 
 
 VCSAdapter: TypeAlias = RepositoryFileClient

tests/test_pipeline.py

@@ -1,5 +1,4 @@
 import pathlib
-import sys
 
 from click.testing import CliRunner
 
@@ -9,11 +8,27 @@
 def test_pipeline_local(caplog):
     runner = CliRunner()
     root_path = pathlib.Path(__file__).parent.parent
-    config_path = root_path / 'examples/logger/config.yml'
+    config_path = root_path / "examples/logger/config.yml"
     msg = "test message"
-    result = runner.invoke(cli, ['--local', str(config_path)], env={
-        "MESSAGE": msg,
-        "LOG_LEVEL": "INFO"
-    })
+    result = runner.invoke(
+        cli, ["--local", str(config_path)], env={"MESSAGE": msg, "LOG_LEVEL": "INFO"}
+    )
     assert result.exit_code == 0
-    assert msg in caplog.messages
+    assert msg in caplog.messages
+
+
+def test_pipeline_github(caplog):
+    runner = CliRunner()
+    msg = "test message"
+    result = runner.invoke(
+        cli,
+        [
+            "--source", "github",
+            "--repository", "gaarutyunov/pype",
+            "--file", "examples/logger/config.yml",
+            "--ref", "main",
+        ],
+        env={"MESSAGE": msg, "LOG_LEVEL": "INFO"},
+    )
+    assert result.exit_code == 0
+    assert msg in caplog.messages