Wip (#3)

rndmit · web-flow · commit aaccda0e14d8 · 2023-04-15T18:28:10.000+06:00
* Fix README

* Add missing TODO item

* Add lint target

* Edit actions

* Fix wrong ref

* Fix wrong ref

* Fix runs-on label

* Add dev image

* Fix image name

* Fix

* Fix

* Add label

* Use dev image in pipeline

* Fix

* Fix

* Fix

* Fix

* Fix

* Fix

* Ordered option resolve

* Edit docstring

* Options improvements

* Linting and docs gen

* Fix linter issues

* Add generated docs

* Rename step

* Add tests

* Tests in CI

* Fix ci

* Rebuild dev-image

* Restrict test/lint

* Fix ci
diff --git a/.github/workflows/.lint.yml b/.github/workflows/.lint.yml
@@ -18,4 +18,5 @@ jobs:
       uses: actions/checkout@v3
     - 
       name: Running flake8
-      run: flake8 pycli/
+
+      run: make lint
diff --git a/.github/workflows/.test.yml b/.github/workflows/.test.yml
@@ -0,0 +1,21 @@
+name: lint
+
+on:
+  workflow_call:
+    inputs: 
+      dev_image_name:
+        required: true
+        type: string
+    secrets: {}
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ inputs.dev_image_name }}:latest
+    steps:
+    - 
+      uses: actions/checkout@v3
+    - 
+      name: Running pytest
+      run: make unit-test
diff --git a/.github/workflows/dev-image.yml b/.github/workflows/dev-image.yml
@@ -1,12 +1,11 @@
 on:
-  pull_request:
-    types: 
-      - opened 
-      - reopened
+  push:
     branches:
       - master
     paths:
       - Dockerfile
+      - pyproject.toml
+      - poetry.lock
 
 jobs:
   build-dev-image:
diff --git a/.github/workflows/wip.yml b/.github/workflows/wip.yml
@@ -2,6 +2,9 @@ on:
   push:
     branches:
       - wip
+    paths:
+      - pycli/
+      - tests/
   pull_request:
     types: 
       - opened 
@@ -12,7 +15,11 @@ on:
       - pycli/
 
 jobs:
-  pylint:
+  lint:
     uses: ./.github/workflows/.lint.yml
     with:
-      dev_image_name: ${{ vars.DEV_IMAGE_NAME }}
+      dev_image_name: ${{ vars.DEV_IMAGE_NAME }}
+  test:
+    uses: ./.github/workflows/.test.yml
+    with:
+      dev_image_name: ${{ vars.DEV_IMAGE_NAME }}
diff --git a/docs/api/api.md b/docs/api/api.md
@@ -39,8 +39,9 @@ Registers Command within application's root command
 #### run
 
 ```python
-def run() -> int
-```
+
+def run(argv: list[str] = None) -> int
+
 
 Runs Application lifecycle
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pycli/app.py b/pycli/app.py
@@ -31,8 +31,8 @@ def __init__(self, name, descr=None, *opts: Option):
             for opt in opts:
                 self.opts.append(opt)
 
-        def exec(self, opts):
-            return
+        def exec(self, vals):
+            return 0
 
     __messager: Messager
     root_cmd: Command
@@ -62,15 +62,17 @@ def with_commands(self, *cmds: Command) -> Self:
             self.root_cmd.children.append(cmd)
         return self
 
-    def run(self) -> int:
+    def run(self, argv: list[str] = None) -> int:
         """Runs Application lifecycle
 
         Returns:
             Numeric result code
         """
-        inputl = sys.argv[1:]
-        cmd, opts, cmdpath = self.root_cmd.process(inputl, set())
-        args = [x for x in inputl if x not in cmdpath]
+        if argv is None:
+            argv = sys.argv[1:]
+        cmd, opts, cmdpath = self.root_cmd.process(argv, set())
+        args = [x for x in argv if x not in cmdpath]
+
         values, args = Values.from_opts_args(list(opts), args)
         cpath = [self.root_cmd.name, *cmdpath]
         if len(args) != 0:
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,7 +11,6 @@ jinja2 = "^3.1.2"
 rich = "^13.3.2"
 
 [tool.poetry.group.dev.dependencies]
-black = "^23.1.0"
 flake8 = "^6.0.0"
 pydoc-markdown = {extras = ["novella"], version = "^4.6.4"}
 novella = "^0.2.5"
diff --git a/tests/templates/__init__.py b/tests/templates/__init__.py
@@ -0,0 +1,3 @@
+from .app import create_test_app
+from . import cmds
+from . import opts
diff --git a/tests/templates/app.py b/tests/templates/app.py
@@ -0,0 +1,5 @@
+from pycli import Application
+
+
+def create_test_app(name = "test app", descr = None, global_opts = None):
+    return Application(name, descr, global_opts)
diff --git a/tests/templates/cmds.py b/tests/templates/cmds.py
@@ -0,0 +1,32 @@
+from pycli import Command
+from .opts import custom_rc
+
+
+class TestCommand(Command):
+    name = "test"
+    short = "command for usage with tests"
+    long = "Empty command for usage with tests"
+
+    def exec(self, vals):
+        return 0
+    
+class TestCommandWithCustomRC(TestCommand):
+    _opt_custom_rc = custom_rc
+
+    def exec(self, vals):
+        rc = vals.get(custom_rc)
+        if rc:
+            return rc
+        return 0
+    
+class TestCommandWithSubcommand(TestCommand):
+    class Subcommand(Command):
+        name = "subtest"
+
+        def exec(self, vals):
+            return 0
+        
+    children = [Subcommand()]
+
+    def exec(self, vals):
+        return 0
diff --git a/tests/templates/opts.py b/tests/templates/opts.py
@@ -0,0 +1,3 @@
+from pycli import Option
+
+custom_rc = Option[int]("rc")
diff --git a/tests/test_app.py b/tests/test_app.py
@@ -1,11 +1,47 @@
 import pytest
 from pycli import Application
+from . import templates as t
 
 
-def test_new_app():
-    a = Application("test app")
-    assert a.root_cmd.name == "test app"
+def test_empty_app():
+    app = t.create_test_app()
+    assert app.root_cmd.name == "test app"
+    assert app.root_cmd.long == None
+    rc = app.run([])
+    assert rc == 0
+    rc = app.run(["not-existing-command"])
+    assert rc == 1
 
-    with pytest.raises(TypeError) as e:
-        a = Application()
-    assert "missing 1 required positional argument: 'name'" in str(e.value)
+
+def test_app_with_commands():
+    app = t.create_test_app().with_commands(t.cmds.TestCommand())
+    assert isinstance(app.root_cmd.children[0], t.cmds.TestCommand)
+    rc = app.run(["test"])
+    assert rc == 0
+    rc = app.run(["rest"])
+    assert rc == 1
+    rc = app.run("test and rest".split(" "))
+    assert rc == 1
+
+
+def test_app_with_opts():
+    app = t.create_test_app().with_commands(t.cmds.TestCommandWithCustomRC())
+    rc = app.run(["test"])
+    assert rc == 0
+    rc = app.run("test --rc 42".split(" "))
+    assert rc == 42
+    rc = app.run("test --idk".split(" "))
+    assert rc == 1
+    rc = app.run("test --idk --rc 42".split(" "))
+    assert rc == 1
+
+
+def test_app_with_subcommands():
+    app = t.create_test_app().with_commands(t.cmds.TestCommandWithSubcommand())
+    assert app.root_cmd.children[0].children is not None
+    rc = app.run(["test"])
+    assert rc == 0
+    rc = app.run("test subtest".split(" "))
+    assert rc == 0
+    rc = app.run("test subrest".split(" "))
+    assert rc == 1

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,5 @@ jobs:`
`18`	`18`	`uses: actions/checkout@v3`
`19`	`19`	`-`
`20`	`20`	`name: Running flake8`
`21`		`- run: flake8 pycli/`
	`21`	`+`
	`22`	`+ run: make lint`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .app import create_test_app`
	`2`	`+from . import cmds`
	`3`	`+from . import opts`