Unified task runner scripts (#1086)

Author: approxit

.github/workflows/build_publish.yml

@@ -18,10 +18,10 @@ jobs:
         with:
           poetry-version: 1.2.2
       - run: poetry install
-      - run: poetry run poe test
-      - run: poetry run poe typecheck
-      - run: poetry run poe codestyle
-      - run: poetry run poe liccheck
+      - run: poetry run poe tests_unit
+      - run: poetry run poe checks_codestyle
+      - run: poetry run poe checks_typing
+      - run: poetry run poe checks_license
 
   build:
     needs: [test]

.github/workflows/goth-nightly.yml

@@ -86,8 +86,8 @@ jobs:
         env:
           GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          poetry run poe goth-assets
-          poetry run poe goth-tests
+          poetry run poe tests_integration_assets
+          poetry run poe tests_integration
 
       - name: Upload test logs
         uses: actions/upload-artifact@v2

.github/workflows/goth.yml

@@ -57,8 +57,8 @@ jobs:
         env:
           GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          poetry run poe goth-assets
-          poetry run poe goth-tests
+          poetry run poe tests_integration_assets
+          poetry run poe tests_integration
 
       - name: Upload test logs
         uses: actions/upload-artifact@v2

.github/workflows/tests.yml

@@ -50,11 +50,11 @@ jobs:
       - run: poetry install -E docs
         if: ${{ steps.extended-checks-sphinx.outputs.ENABLE }}
 
-      - run: poetry run poe test
-      - run: poetry run poe typecheck
-      - run: poetry run poe codestyle
+      - run: poetry run poe tests_unit
+      - run: poetry run poe checks_codestyle
+      - run: poetry run poe checks_typing
         if: ${{ steps.extended-checks.outputs.ENABLE }}
-      - run: poetry run poe liccheck
+      - run: poetry run poe checks_license
         if: ${{ steps.extended-checks.outputs.ENABLE }}
       - run: poetry run poe sphinx -W
         if: ${{ steps.extended-checks-sphinx.outputs.ENABLE }}

.gitignore

@@ -8,7 +8,7 @@ __pycache__/
 *.log
 *.png
 .coverage
-.requirements.txt
+requirements.txt
 
 tests/goth_tests/assets/
 

README.md

@@ -68,7 +68,7 @@ All of the project's dependencies will be installed to that virtual environment.
 Declarations of project tasks can be found in `pyproject.toml`.
 
 ```bash
-poetry run poe test
+poetry run poe tests_unit
 ```
 
 ### Running `goth` integration tests
@@ -96,23 +96,23 @@ poetry install -E integration-tests
 Finally, generate goth's default assets:
 
 ```bash
-poetry run poe goth-assets
+poetry run poe tests_integration_assets
 ```
 
 #### Running the tests
 
 Once you have the environment set up, to run all the integration tests, use:
 
 ```bash
-poetry run poe goth-tests
+poetry run poe tests_integration
 ```
 
 ### Contributing
 
 It is recommended to run unit tests and static code analysis before committing changes.
 
 ```bash
-poetry run poe check
+poetry run poe checks
 ```
 
 You can clean up the artifacts created during the test runs with:

docs/sphinx/conf.py

@@ -12,6 +12,7 @@
 #
 import os
 import sys
+from typing import List
 
 sys.path.insert(0, os.path.abspath("../../"))
 
@@ -56,7 +57,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path: List[str] = []
 
 #   This removes the `yapapi.log` docstrings.
 #   There are two reasons:

examples/blender/blender.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
-from datetime import datetime, timedelta
 import pathlib
 import sys
+from datetime import datetime, timedelta
 
 from yapapi import Golem, Task, WorkContext
 from yapapi.payload import vm
@@ -31,7 +31,8 @@ async def main(
         min_mem_gib=0.5,
         # only run on provider nodes that have more than 2gb of storage space available
         min_storage_gib=2.0,
-        # only run on provider nodes which a certain number of CPU threads (logical CPU cores) available
+        # only run on provider nodes which a certain number of CPU threads (logical CPU cores)
+        #  available
         min_cpu_threads=min_cpu_threads,
     )
 

examples/blender/start_stop_blender.py

@@ -2,14 +2,14 @@
 
 """Other version of the blender example.
 
-Instead of using Golem in the default way - as a context manager - we directly call `Golem.start()` and `Golem.stop()`.
-This way of using Golem might be more convenient for some specific use cases (although doesn't change a lot
-in the blender example).
+Instead of using Golem in the default way - as a context manager - we directly call `Golem.start()`
+and `Golem.stop()`. This way of using Golem might be more convenient for some specific use cases
+(although doesn't change a lot in the blender example).
 """
 
-from datetime import datetime, timedelta
 import pathlib
 import sys
+from datetime import datetime, timedelta
 
 from yapapi import Golem, Task, WorkContext
 from yapapi.payload import vm

examples/custom-usage-counter/custom_usage_counter.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python3
 import asyncio
-from dataclasses import dataclass
-from datetime import datetime, timedelta
-from decimal import Decimal
 import pathlib
 import sys
+from datetime import datetime, timedelta
+from decimal import Decimal
+
+from dataclasses import dataclass
 
 from yapapi import Golem
 from yapapi.ctx import ActivityUsage
@@ -101,6 +102,8 @@ def print_instances():
         type=int,
         help="How long should the the service run (in seconds, default: %(default)s)",
     )
+    now = datetime.now().strftime("%Y-%m-%d_%H.%M.%S")
+    parser.set_defaults(log_file=f"custom-counters-yapapi-{now}.log")
     args = parser.parse_args()
     enable_default_logger(
         log_file=args.log_file,