Extension Mechanism Implementation

.github/actions/publish-from-template/action.yml

@@ -16,8 +16,7 @@ runs:
       shell: bash
       env: ${{ env }}
       run:
-        python .github/actions/publish-from-template/render_template.py ${{
-        inputs.filename }}
+        python ${{ github.action_path }}/render_template.py ${{inputs.filename }}
 
     - uses: JasonEtco/create-an-issue@v2
       # Only render template and create an issue in case the workflow is a scheduled one

.github/workflows/kubernetes_test.yaml

@@ -177,6 +177,7 @@ jobs:
           pytest tests/tests_deployment/ -v -s
 
       - name: JupyterHub Notebook Tests
+        timeout-minutes: 2
         # run jhub-client after pytest since jhubctl can cleanup
         # the running server
         run: |

.github/workflows/test-provider.yaml

@@ -85,6 +85,8 @@ jobs:
             kv/data/repository/nebari-dev/nebari/azure/nebari-dev-ci/github-nebari-dev-repo-ci tenant_id | ARM_TENANT_ID;
             kv/data/repository/nebari-dev/nebari/azure/nebari-dev-ci/github-nebari-dev-repo-ci subscription_id | ARM_SUBSCRIPTION_ID;
             kv/data/repository/nebari-dev/nebari/shared_secrets DIGITALOCEAN_TOKEN | DIGITALOCEAN_TOKEN;
+            kv/data/repository/nebari-dev/nebari/shared_secrets SPACES_ACCESS_KEY_ID | SPACES_ACCESS_KEY_ID;
+            kv/data/repository/nebari-dev/nebari/shared_secrets SPACES_SECRET_ACCESS_KEY | SPACES_SECRET_ACCESS_KEY;
 
       - name: 'Authenticate to GCP'
         if: ${{ matrix.provider == 'gcp' }}
@@ -123,7 +125,7 @@ jobs:
 
       - name: Nebari Initialize
         run: |
-          nebari init "${{ matrix.provider }}" --project "TestProvider" --domain "${{ matrix.provider }}.nebari.dev" --auth-provider github --disable-prompt --ci-provider ${{ matrix.cicd }}
+          nebari init "${{ matrix.provider }}" --project "TestProvider" --domain "${{ matrix.provider }}.nebari.dev" --auth-provider password --disable-prompt --ci-provider ${{ matrix.cicd }}
           cat "nebari-config.yaml"
 
       - name: Nebari Render

.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
       - id: check-json
       - id: check-yaml
         # jinja2 templates for helm charts
-        exclude: "src/_nebari/template/stages/07-kubernetes-services/modules/kubernetes/services/(clearml/chart/templates/.*|prefect/chart/templates/.*)"
+        exclude: "src/_nebari/stages/kubernetes_services/template/modules/kubernetes/services/(clearml/chart/templates/.*|prefect/chart/templates/.*)"
         args: [--allow-multiple-documents]
       - id: check-toml
       # Lint: Checks that non-binary executables have a proper shebang.

pyproject.toml

@@ -54,6 +54,7 @@ classifiers = [
 ]
 
 dependencies = [
+    "pluggy==1.0.0",
     "auth0-python==4.0.0",
     "azure-identity==1.12.0",
     "azure-mgmt-containerservice==19.1.0",
@@ -96,7 +97,7 @@ Documentation = "https://www.nebari.dev/docs"
 Source = "/~https://github.com/nebari-dev/nebari"
 
 [project.scripts]
-nebari = "_nebari.cli.main:app"
+nebari = "nebari.__main__:main"
 
 [tool.ruff]
 select = [

pytest.ini

@@ -6,6 +6,8 @@ addopts =
     --tb=native
     # turn warnings into errors
     -Werror
+    # ignore deprecation warnings (TODO: filter further)
+    -W ignore::DeprecationWarning
 markers =
     conda: conda required to run this test (deselect with '-m \"not conda\"')
     aws: deploy on aws

src/_nebari/cli.py

@@ -0,0 +1,84 @@
+import typing
+
+import typer
+from typer.core import TyperGroup
+
+from _nebari.version import __version__
+from nebari.plugins import nebari_plugin_manager
+
+
+class OrderCommands(TyperGroup):
+    def list_commands(self, ctx: typer.Context):
+        """Return list of commands in the order appear."""
+        return list(self.commands)
+
+
+def version_callback(value: bool):
+    if value:
+        typer.echo(__version__)
+        raise typer.Exit()
+
+
+def exclude_stages(ctx: typer.Context, stages: typing.List[str]):
+    nebari_plugin_manager.excluded_stages = stages
+    return stages
+
+
+def exclude_default_stages(ctx: typer.Context, exclude_default_stages: bool):
+    nebari_plugin_manager.exclude_default_stages = exclude_default_stages
+    return exclude_default_stages
+
+
+def import_plugin(plugins: typing.List[str]):
+    try:
+        nebari_plugin_manager.load_plugins(plugins)
+    except ModuleNotFoundError:
+        typer.echo(
+            "ERROR: Python module {e.name} not found. Make sure that the module is in your python path {sys.path}"
+        )
+        typer.Exit()
+    return plugins
+
+
+def create_cli():
+    app = typer.Typer(
+        cls=OrderCommands,
+        help="Nebari CLI 🪴",
+        add_completion=False,
+        no_args_is_help=True,
+        rich_markup_mode="rich",
+        pretty_exceptions_show_locals=False,
+        context_settings={"help_option_names": ["-h", "--help"]},
+    )
+
+    @app.callback()
+    def common(
+        ctx: typer.Context,
+        version: bool = typer.Option(
+            None,
+            "-V",
+            "--version",
+            help="Nebari version number",
+            callback=version_callback,
+        ),
+        plugins: typing.List[str] = typer.Option(
+            [],
+            "--import-plugin",
+            help="Import nebari plugin",
+        ),
+        excluded_stages: typing.List[str] = typer.Option(
+            [],
+            "--exclude-stage",
+            help="Exclude nebari stage(s) by name or regex",
+        ),
+        exclude_default_stages: bool = typer.Option(
+            False,
+            "--exclude-default-stages",
+            help="Exclude default nebari included stages",
+        ),
+    ):
+        pass
+
+    nebari_plugin_manager.plugin_manager.hook.nebari_subcommand(cli=app)
+
+    return app