diff --git a/.env-template b/.env-template new file mode 100644 index 0000000..6e26392 --- /dev/null +++ b/.env-template @@ -0,0 +1,9 @@ +RABBITMQ_USERNAME=guest +RABBITMQ_PASSWORD=1234 +RABBITMQ_HOSTNAME=localhost +RABBITMQ_PORT=5672 + +POSTGRESQL_USERNAME=guest +POSTGRESQL_PASSWORD=1234 +POSTGRESQL_HOSTNAME=localhost +POSTGRESQL_PORT=5432 diff --git a/.github/workflows/BuildTest_win32.yml b/.github/workflows/BuildTest_win32.yml new file mode 100644 index 0000000..0cef210 --- /dev/null +++ b/.github/workflows/BuildTest_win32.yml @@ -0,0 +1,31 @@ +name: Build-Test-Lint (win32) + +on: + pull_request: + types: [ opened, reopened, synchronize ] + +jobs: + build: + runs-on: windows-latest + strategy: + matrix: + python-version: ["3.11"] +# python-version: [3.8, 3.9, 3.10, 3.11] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + - run: | + .\ci\win32\create_venv.cmd + .\ci\win32\install_dependencies.cmd + + - name: run unit tests + run: | + .\ci\win32\test_unit.cmd + + - name: Lint + run: | + .\ci\win32\lint.cmd diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..76ba7a8 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,89 @@ +name: Build-Test-Lint-etc (linux) + +on: [push] + +jobs: + + flake8-lint: + runs-on: ubuntu-latest + name: Lint + steps: + - name: Check out source repository + uses: actions/checkout@v3 + - name: Set up Python environment + uses: actions/setup-python@v4 + with: + python-version: 3.11 + - name: flake8 Lint + uses: TrueBrain/actions-flake8@v2 + with: + plugins: Flake8-pyproject==1.2.3 flake8-docstrings==1.7.0 flake8-quotes==3.3.2 + # only_warn: 1 #causes action to always be succesful, but still provide annotations + + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.11"] +# python-version: [3.8, 3.9, 3.10, 3.11] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + - run: | + ./ci/linux/create_venv.sh + ./ci/linux/install_dependencies.sh + + - name: run unit tests + run: | + ./ci/linux/test_unit.sh + + - name: Surface failing tests + if: always() + uses: pmeier/pytest-results-action@main + with: + # A list of JUnit XML files, directories containing the former, and wildcard + # patterns to process. + # See @actions/glob for supported patterns. + path: test-results.xml + + # Add a summary of the results at the top of the report + # Default: true + summary: true + + # Select which results should be included in the report. + # Follows the same syntax as + # `pytest -r` + # Default: fEX + display-options: fEX + + # Fail the workflow if no JUnit XML was found. + # Default: true + fail-on-empty: true + + typecheck: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.11"] +# python-version: [3.8, 3.9, 3.10, 3.11] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + - run: | + ./ci/linux/create_venv.sh + ./ci/linux/install_dependencies.sh + + - name: Add mypy annotator + uses: pr-annotators/mypy-pr-annotator@v1.0.0 + + - name: run typechecker + run: | + ./ci/linux/typecheck.sh diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..28abe68 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,70 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '22 6 * * 2' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://git.io/codeql-language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/container_image.yml b/.github/workflows/container_image.yml new file mode 100644 index 0000000..821be0a --- /dev/null +++ b/.github/workflows/container_image.yml @@ -0,0 +1,25 @@ +#name: Deply to GitHub Container Registry +run-name: Releasing next version 🚀 +on: + push: + tags: + - '*' + +jobs: + publish-docker-image: + runs-on: ubuntu-latest + steps: + - name: Checkout sources + uses: actions/checkout@v2 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build the container image + run: | + docker build . --tag ghcr.io/project-omotes/orchestrator:latest --tag ghcr.io/project-omotes/orchestrator:${{ github.ref_name}} + docker push ghcr.io/project-omotes/orchestrator:latest ghcr.io/project-omotes/orchestrator:${{ github.ref_name}} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..85047aa --- /dev/null +++ b/.gitignore @@ -0,0 +1,224 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +doc/*/_build/ +doc/*/_static/ +doc/*/_templates/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +### PyCharm+all ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### PyCharm+all Patch ### +# Ignore everything but code style settings and run configurations +# that are supposed to be shared within teams. + +.idea/* + +!.idea/codeStyles +!.idea/runConfigurations + +unit_test_coverage/ +test-results.xml + +.env.* \ No newline at end of file diff --git a/.taplo.toml b/.taplo.toml new file mode 100644 index 0000000..66d8049 --- /dev/null +++ b/.taplo.toml @@ -0,0 +1,5 @@ +include = ["pyproject.toml"] + + +[schema] +path = "https://json.schemastore.org/pyproject.json" diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e406a3 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "python.analysis.typeCheckingMode": "basic", + "[python]": { + "editor.defaultFormatter": "ms-python.black-formatter" + }, + "python.formatting.provider": "black", + "mypy.runUsingActiveInterpreter": true, +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..149a75c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] - 2024-3-31 +### Added +- New functionality added to the project, with reference to issue-ticket (#123) +- Another new item (#1234) + +### Fixed +- bugfixes, with references to your issue-tickets (#123) +- another bugfix (#1234) + +### Changed +- Changes, for example code structure +- but also changed/updated dependencies +- Add references to tickets where applicable (#123) + +### Removed +- Files that have been removed +- Functionality that has been removed +- Add references to tickets where applicable (#123) + +## [0.0.1] - 2023-09-21 +### Added +- Kickoff of Nieuwe Warmte Nu!. +- initialized repo from template. + +### Changed +- everything. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cf3607f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# This file +This file should describe the development process for this project and include instruction on +how to run/build your project. Any environment settings/requirements? + +# Development guidelines +The general proces is as follows: +* Create a branch on your local working copy +* make code modifications, including tests, documentation, etc +* commit/push changes to remote/origin +* submit a pull request for merging into master +* Discuss with code reviewer if/what changes are needed +* when all discussions are resolved, the PR will be merged by the reviewer +* Update Changelog! + + +# Code Quality guide lines +Quality guide lines serve to improve quality. They should not be busy work nor work against developers. +They should be of value. + +## Code review +- Every commit should be created on its own branch and submitted per pull request to be merged with the main branch. +- Every pull request must be reviewed by at least one other developer and all comments must be resolved. +- No linting issues may remain before merging. +- No type checking issues may remain before merging. +- Code reviews are not about distrust. They are about sharing knowledge about the code base, sharing knowledge about + writing code and increasing quality by collaboration. + +## Documentation +- Every function must have documentation explaining what the function does in a summary and explaining + each argument and return type. + +## Linting +- Linting maintains a shared quality of the code base across repositories. +- Rules of the linter may only be ignored when approved by the software leads. Prefer to silence individual lines by ' + +## Type checking +- Every function must have a return type and an argument list annotated with functions. +- Rules of the type checker may only be ignored when approved by the software leads. +- + +## Testing +### Unit testing +- Every function should be covered by a unit test. Some functions allow more easily for unit tests and some are not + worth unit testing. This is up to the teams discretion. +- A unit test should test some significant amount of code. If the test function is similar or equal to the logic being tested, +the amount of code being tested is too small. If the test function tests whole modules or multiple layers of code, the amount +of code being tested is too big. The amount of code being tested is referred to as the 'unit-under-test'. +- Use mocks to isolate 'unit-under-test' where applicable. +- Coverage percentage should be >80%. This is a guideline, not a hard rule. Breaking this guideline is allowed if the + arguments has swayed the developersteam and not just the developer and reviewer. + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ed990f8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,621 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..302bbfe --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# OMOTES orchestrator + +This repository is part of the 'Nieuwe Warmte Nu Design Toolkit' project. + +Orchestrator component of OMOTES project which monitors workflows and starts the various steps of each workflow. diff --git a/ci/linux/build_python_package.sh b/ci/linux/build_python_package.sh new file mode 100755 index 0000000..5f4244f --- /dev/null +++ b/ci/linux/build_python_package.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +python -m build diff --git a/ci/linux/create_venv.sh b/ci/linux/create_venv.sh new file mode 100755 index 0000000..b6345ed --- /dev/null +++ b/ci/linux/create_venv.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env sh + +python3.11 -m venv ./.venv +. .venv/bin/activate +pip3 install pip-tools diff --git a/ci/linux/gen_protocol.sh b/ci/linux/gen_protocol.sh new file mode 100755 index 0000000..8880275 --- /dev/null +++ b/ci/linux/gen_protocol.sh @@ -0,0 +1,3 @@ +#!/bin/bash +protoc -I protocol_definition/ --python_out src/omotes_orchestrator/proto_gen/ ./protocol_definition/omotes.proto +protoc -I protocol_definition/ --mypy_out src/omotes_orchestrator/proto_gen/ ./protocol_definition/omotes.proto diff --git a/ci/linux/install_dependencies.sh b/ci/linux/install_dependencies.sh new file mode 100755 index 0000000..0447bed --- /dev/null +++ b/ci/linux/install_dependencies.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +pip-sync ./dev-requirements.txt ./requirements.txt diff --git a/ci/linux/lint.sh b/ci/linux/lint.sh new file mode 100755 index 0000000..da7dfeb --- /dev/null +++ b/ci/linux/lint.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +flake8 ./src/omotes_orchestrator diff --git a/ci/linux/test_unit.sh b/ci/linux/test_unit.sh new file mode 100755 index 0000000..b810a25 --- /dev/null +++ b/ci/linux/test_unit.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +PYTHONPATH='$PYTHONPATH:src/' pytest --junit-xml=test-results.xml unit_test/ diff --git a/ci/linux/typecheck.sh b/ci/linux/typecheck.sh new file mode 100755 index 0000000..de32ead --- /dev/null +++ b/ci/linux/typecheck.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +python -m mypy ./src/omotes_orchestrator ./unit_test/ diff --git a/ci/linux/update_dependencies.sh b/ci/linux/update_dependencies.sh new file mode 100755 index 0000000..0d5bb9a --- /dev/null +++ b/ci/linux/update_dependencies.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env sh + +. .venv/bin/activate +pip-compile --output-file=requirements.txt pyproject.toml +pip-compile --extra=dev -c requirements.txt --output-file=dev-requirements.txt pyproject.toml diff --git a/ci/win32/create_venv.cmd b/ci/win32/create_venv.cmd new file mode 100644 index 0000000..edb05f0 --- /dev/null +++ b/ci/win32/create_venv.cmd @@ -0,0 +1,9 @@ +rem Short script to initialize virtual environment using venv and pip +rem @echo off + +pushd . +cd /D "%~dp0" +py -3.11 -m venv ..\..\venv +call ..\..\venv\Scripts\activate.bat +python -m pip install pip-tools +popd diff --git a/ci/win32/install_dependencies.cmd b/ci/win32/install_dependencies.cmd new file mode 100644 index 0000000..e76c29d --- /dev/null +++ b/ci/win32/install_dependencies.cmd @@ -0,0 +1,6 @@ + +pushd . +cd /D "%~dp0" +cd ..\..\ +pip-sync .\dev-requirements.txt .\requirements.txt +popd \ No newline at end of file diff --git a/ci/win32/lint.cmd b/ci/win32/lint.cmd new file mode 100644 index 0000000..2547a40 --- /dev/null +++ b/ci/win32/lint.cmd @@ -0,0 +1,8 @@ +rem Short script to run linting +rem @echo off + +pushd . +cd /D "%~dp0" +cd ..\..\ +flake8 .\src\omotes_orchestrator +popd diff --git a/ci/win32/test_unit.cmd b/ci/win32/test_unit.cmd new file mode 100644 index 0000000..c2d51b8 --- /dev/null +++ b/ci/win32/test_unit.cmd @@ -0,0 +1,9 @@ + +pushd . +cd /D "%~dp0" + +cd ..\..\ +call .\venv\Scripts\activate +set PYTHONPATH=.\src\;%$PYTHONPATH% +pytest unit_test/ +popd \ No newline at end of file diff --git a/ci/win32/update_dependencies.cmd b/ci/win32/update_dependencies.cmd new file mode 100644 index 0000000..2725179 --- /dev/null +++ b/ci/win32/update_dependencies.cmd @@ -0,0 +1,6 @@ + +pushd . +cd /D "%~dp0" +pip-compile --output-file=..\..\requirements.txt ..\..\pyproject.toml +pip-compile --extra=dev --output-file=..\..\dev-requirements.txt ..\..\pyproject.toml +popd \ No newline at end of file diff --git a/dev-requirements.txt b/dev-requirements.txt new file mode 100644 index 0000000..9bfb6cc --- /dev/null +++ b/dev-requirements.txt @@ -0,0 +1,160 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile --constraint=requirements.txt --extra=dev --output-file=dev-requirements.txt pyproject.toml +# +amqp==5.2.0 + # via + # -c requirements.txt + # kombu +billiard==4.2.0 + # via + # -c requirements.txt + # celery +black==22.1.0 + # via orchestrator (pyproject.toml) +build==1.0.3 + # via orchestrator (pyproject.toml) +celery[sqlalchemy]==5.3.6 + # via + # -c requirements.txt + # orchestrator (pyproject.toml) +click==8.1.7 + # via + # -c requirements.txt + # black + # celery + # click-didyoumean + # click-plugins + # click-repl +click-didyoumean==0.3.0 + # via + # -c requirements.txt + # celery +click-plugins==1.1.1 + # via + # -c requirements.txt + # celery +click-repl==0.3.0 + # via + # -c requirements.txt + # celery +coverage[toml]==7.3.2 + # via pytest-cov +dataclass-binder==0.3.4 + # via + # -c requirements.txt + # orchestrator (pyproject.toml) +flake8==6.0.0 + # via + # flake8-docstrings + # flake8-pyproject + # flake8-quotes + # orchestrator (pyproject.toml) +flake8-docstrings==1.7.0 + # via orchestrator (pyproject.toml) +flake8-pyproject==1.2.3 + # via orchestrator (pyproject.toml) +flake8-quotes==3.3.2 + # via orchestrator (pyproject.toml) +greenlet==3.0.1 + # via + # -c requirements.txt + # sqlalchemy +iniconfig==2.0.0 + # via pytest +jsonpickle==3.0.2 + # via + # -c requirements.txt + # orchestrator (pyproject.toml) +kombu==5.3.4 + # via + # -c requirements.txt + # celery +mccabe==0.7.0 + # via flake8 +mypy==1.5.1 + # via orchestrator (pyproject.toml) +mypy-extensions==1.0.0 + # via + # black + # mypy +packaging==23.2 + # via + # build + # pytest + # setuptools-git-versioning +pathspec==0.11.2 + # via black +platformdirs==4.1.0 + # via black +pluggy==1.3.0 + # via pytest +prompt-toolkit==3.0.41 + # via + # -c requirements.txt + # click-repl +psycopg2==2.9.9 + # via + # -c requirements.txt + # orchestrator (pyproject.toml) +pycodestyle==2.10.0 + # via flake8 +pydocstyle==6.3.0 + # via flake8-docstrings +pyflakes==3.0.1 + # via flake8 +pyproject-hooks==1.0.0 + # via build +pytest==7.3.2 + # via + # orchestrator (pyproject.toml) + # pytest-cov +pytest-cov==4.0.0 + # via orchestrator (pyproject.toml) +python-dateutil==2.8.2 + # via + # -c requirements.txt + # celery +python-dotenv==1.0.0 + # via + # -c requirements.txt + # orchestrator (pyproject.toml) +setuptools-git-versioning==1.13.5 + # via orchestrator (pyproject.toml) +six==1.16.0 + # via + # -c requirements.txt + # python-dateutil +snowballstemmer==2.2.0 + # via pydocstyle +sqlalchemy==2.0.23 + # via + # -c requirements.txt + # celery + # orchestrator (pyproject.toml) +tomli==2.0.1 + # via black +typing-extensions==4.8.0 + # via + # -c requirements.txt + # mypy + # sqlalchemy +tzdata==2023.3 + # via + # -c requirements.txt + # celery +vine==5.1.0 + # via + # -c requirements.txt + # amqp + # celery + # kombu +wcwidth==0.2.12 + # via + # -c requirements.txt + # prompt-toolkit + +# The following packages are considered to be unsafe in a requirements file: +# setuptools diff --git a/doc/dev_documentation/Makefile b/doc/dev_documentation/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/doc/dev_documentation/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/dev_documentation/Tools.rst b/doc/dev_documentation/Tools.rst new file mode 100644 index 0000000..2f4653f --- /dev/null +++ b/doc/dev_documentation/Tools.rst @@ -0,0 +1,60 @@ +Tools & IDE's +=================================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + +There are numerous IDE's for developing python applications, but we +will focus on two: Visual Studio Code and PyCharm + +General +------- +Python code can be writtin using any text editor. However, we've chosen the following tools to support us: + +- **Black** for code formatting +- **Flake8** for code linting +- **MyPy** for typehints/typeChecking +- **pytest** for unit testing +- + +PyCharm +------- + + + + + +VS Code +------- + +The following extensions should be installed: + +* https://marketplace.visualstudio.com/items?itemName=ms-python.python +* https://marketplace.visualstudio.com/items?itemName=ms-python.flake8 +* https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter +* https://marketplace.visualstudio.com/items?itemName=matangover.mypy + +settings.json for vscode: + +.. code-block:: JSON + + { + "python.analysis.typeCheckingMode": "basic", + "[python]": { + "editor.defaultFormatter": "ms-python.black-formatter" + }, + "python.formatting.provider": "black", + "mypy.runUsingActiveInterpreter": true, + } + + + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/dev_documentation/conf.py b/doc/dev_documentation/conf.py new file mode 100644 index 0000000..2c567ef --- /dev/null +++ b/doc/dev_documentation/conf.py @@ -0,0 +1,57 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Nieuwe Warmte Nu! python user documentation' +copyright = '2023, NieuweWarmteNu Design Toolkit' +author = 'Sebastiaan la Fleur' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.autosummary", + "sphinx.ext.napoleon", + "sphinx_copybutton", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "furo" + +# 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 = ["_static"] diff --git a/doc/dev_documentation/index.rst b/doc/dev_documentation/index.rst new file mode 100644 index 0000000..77be81e --- /dev/null +++ b/doc/dev_documentation/index.rst @@ -0,0 +1,24 @@ +.. Deltares python Developer documentation documentation master file, created by + sphinx-quickstart on Fri Apr 21 15:13:59 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Design Toolkit python Developer documentation's documentation! +=================================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + Tools + +This is the developer documentation for this project. This documentation provides +information on tools, configurations and howto's for developers. + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/dev_documentation/make.bat b/doc/dev_documentation/make.bat new file mode 100644 index 0000000..954237b --- /dev/null +++ b/doc/dev_documentation/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/doc/user_documentation/Makefile b/doc/user_documentation/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/doc/user_documentation/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/user_documentation/conf.py b/doc/user_documentation/conf.py new file mode 100644 index 0000000..d31a147 --- /dev/null +++ b/doc/user_documentation/conf.py @@ -0,0 +1,52 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Nieuwe Warmte Nu! python user documentation' +copyright = '2023, NieuweWarmteNu Design Toolkit' +author = 'Sebastiaan la Fleur' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# 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 = ['_static'] \ No newline at end of file diff --git a/doc/user_documentation/index.rst b/doc/user_documentation/index.rst new file mode 100644 index 0000000..097493f --- /dev/null +++ b/doc/user_documentation/index.rst @@ -0,0 +1,20 @@ +.. Deltares python user documentation documentation master file, created by + sphinx-quickstart on Fri Apr 21 15:13:29 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Design Toolkit python user documentation's documentation! +============================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/user_documentation/make.bat b/doc/user_documentation/make.bat new file mode 100644 index 0000000..954237b --- /dev/null +++ b/doc/user_documentation/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..07f85b6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,99 @@ +[project] +name = "orchestrator" +dynamic = ["version"] +authors = [{ name = "Sebastiaan la Fleur", email = "sebastiaan.lafleur@tno.nl" }] +description = "Orchestrator component of OMOTES project which monitors workflows and starts the various steps of each workflow." +classifiers = [ + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Intended Audience :: Information Technology", + "Topic :: Scientific/Engineering", + "Topic :: Scientific/Engineering :: Mathematics", + "Topic :: Scientific/Engineering :: Physics", +] + +dependencies = [ + "python-dotenv ~= 1.0.0", + "dataclass-binder ~= 0.3.4", + "sqlalchemy ~= 2.0.23", + "psycopg2 ~= 2.9.9", + "celery[sqlalchemy] ~= 5.3.6", + "omotes-sdk-python ~= 0.0.1", + "omotes-job-tools ~= 0.0.1", + "jsonpickle ~= 3.0.2", +] + +[project.optional-dependencies] +dev = [ + #"pip-tools~=6.13.0", # Installed via create_env script + "black ~= 22.1.0", + "flake8 ~= 6.0.0", + "Flake8-pyproject ~= 1.2.3", + "flake8-docstrings ~= 1.7.0", + "flake8-quotes ~= 3.3.2", + "pytest ~= 7.3.1", + "pytest-cov ~= 4.0.0", + "mypy ~= 1.5.1", + "build ~= 1.0.3", + "setuptools-git-versioning < 2" +] + +[project.urls] +homepage = "https://www.nwn.nu" +documentation = "https://readthedocs.org" +repository = "https://github.com/Nieuwe-Warmte-Nu/orchestrator" +changelog = "https://github.com/Nieuwe-Warmte-Nu/orchestrator/blob/main/CHANGELOG.md" + +[build-system] +build-backend = "setuptools.build_meta" +requires = ["setuptools ~= 67.7.2", "wheel ~= 0.40.0", "setuptools-git-versioning<2"] + +[tools.setuptools] +packages = ["src/omotes_orchestrator"] + +[tool.setuptools-git-versioning] +enabled = true + +[tool.pytest.ini_options] +addopts = "--cov=omotes_orchestrator --cov-report html --cov-report term-missing --cov-fail-under 95" + +[tool.coverage.run] +source = ["src"] + +[tool.flake8] +exclude = ['.venv/*', 'venv/*', 'doc/*'] +ignore = ['Q000', 'D401'] +per-file-ignores = ['__init__.py:F401', 'test_main.py:D100,D101,D102,D103'] +max-line-length = 100 +count = true + +[tool.black] +line-length = 100 + +[tool.mypy] +python_version = "3.11" +warn_return_any = true +warn_unused_configs = true +disallow_untyped_defs = true +disallow_incomplete_defs = true +exclude = [ + '.venv/*', + 'venv/*', + 'doc/*', + 'build', + 'component', + 'testscript', + 'testmodel', + 'tryouts.py', +] + +# mypy per-module options: +[[tool.mypy.overrides]] +module = "unit_test.*" +check_untyped_defs = true +ignore_missing_imports = true diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ad3986e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,57 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile --output-file=requirements.txt pyproject.toml +# +amqp==5.2.0 + # via kombu +billiard==4.2.0 + # via celery +celery[sqlalchemy]==5.3.6 + # via orchestrator (pyproject.toml) +click==8.1.7 + # via + # celery + # click-didyoumean + # click-plugins + # click-repl +click-didyoumean==0.3.0 + # via celery +click-plugins==1.1.1 + # via celery +click-repl==0.3.0 + # via celery +dataclass-binder==0.3.4 + # via orchestrator (pyproject.toml) +greenlet==3.0.1 + # via sqlalchemy +jsonpickle==3.0.2 + # via orchestrator (pyproject.toml) +kombu==5.3.4 + # via celery +prompt-toolkit==3.0.41 + # via click-repl +psycopg2==2.9.9 + # via orchestrator (pyproject.toml) +python-dateutil==2.8.2 + # via celery +python-dotenv==1.0.0 + # via orchestrator (pyproject.toml) +six==1.16.0 + # via python-dateutil +sqlalchemy==2.0.23 + # via + # celery + # orchestrator (pyproject.toml) +typing-extensions==4.8.0 + # via sqlalchemy +tzdata==2023.3 + # via celery +vine==5.1.0 + # via + # amqp + # celery + # kombu +wcwidth==0.2.12 + # via prompt-toolkit diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..d571585 --- /dev/null +++ b/run.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env sh + +. .venv/bin/activate + +PYTHONPATH="src/" python -m omotes_orchestrator.main diff --git a/src/omotes_orchestrator/__init__.py b/src/omotes_orchestrator/__init__.py new file mode 100644 index 0000000..d2dbd22 --- /dev/null +++ b/src/omotes_orchestrator/__init__.py @@ -0,0 +1,22 @@ +# Copyright (c) 2023. Deltares & TNO +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +""" + __init__.py file containing the defaults +""" +import os +from omotes_sdk.app_logging import setup_logging, LogLevel + +setup_logging(LogLevel.parse(os.environ.get("LOG_LEVEL", "DEBUG")), "omotes_orchestrator") diff --git a/src/omotes_orchestrator/celery_interface.py b/src/omotes_orchestrator/celery_interface.py new file mode 100644 index 0000000..098ea58 --- /dev/null +++ b/src/omotes_orchestrator/celery_interface.py @@ -0,0 +1,53 @@ +import threading +import uuid +from dataclasses import dataclass +from functools import partial +from typing import List, Any + +from celery import Celery, Task as CeleryTask +from celery.events import EventReceiver +from celery.result import AsyncResult + +from omotes_sdk.config import RabbitMQConfig +from omotes_sdk.workflow_type import WorkflowType + + +@dataclass +class PostgreSQLConfig: + host: str + port: int + database: str + username: str + password: str + + +class CeleryInterface: + app: Celery + rabbitmq_config: RabbitMQConfig + postgresql_config: PostgreSQLConfig + + def __init__(self, rabbitmq_config: RabbitMQConfig, postgresql_config: PostgreSQLConfig) -> None: + self.rabbitmq_config = rabbitmq_config + self.postgresql_config = postgresql_config + + def start(self) -> None: + postgresql_config = self.postgresql_config + rabbitmq_config = self.rabbitmq_config + + # TODO set late ack, prefetch == 1, ignore results (will the job still exist in postgresql? How does queueing work in this case?), + self.app = Celery( + "omotes", + backend=f"db+postgresql://{postgresql_config.username}:{postgresql_config.password}@{postgresql_config.host}:{postgresql_config.port}/{postgresql_config.database}", + broker=f"pyamqp://{rabbitmq_config.username}:{rabbitmq_config.password}@{rabbitmq_config.host}:{rabbitmq_config.port}/{rabbitmq_config.virtual_host}", + ) + + def stop(self) -> None: + self.app.close() + + def start_workflow(self, workflow_type: WorkflowType, job_id: uuid.UUID, input_esdl: bytes) -> None: + self.app.signature( + workflow_type.workflow_type_name, (job_id, input_esdl), queue=workflow_type.workflow_type_name + ).delay() + + def retrieve_result(self, celery_task_id: str) -> Any: + return self.app.AsyncResult(celery_task_id).get() diff --git a/src/omotes_orchestrator/database.py b/src/omotes_orchestrator/database.py new file mode 100644 index 0000000..2c49ec1 --- /dev/null +++ b/src/omotes_orchestrator/database.py @@ -0,0 +1,65 @@ +import logging +from contextlib import contextmanager +from typing import Generator + +from sqlalchemy import create_engine, orm +from sqlalchemy.engine import URL +from sqlalchemy.orm import Session as SQLSession + +from nwnsdk import PostgresConfig + +LOGGER = logging.getLogger("nwnsdk") + +session_factory = orm.sessionmaker() +Session = orm.scoped_session(session_factory) + + +@contextmanager +def session_scope(do_expunge=False) -> Generator[SQLSession, None, None]: + """Provide a transactional scope around a series of operations. Ensures that the session is + committed and closed. Exceptions raised within the 'with' block using this contextmanager + should be handled in the with block itself. They will not be caught by the 'except' here.""" + try: + yield Session() + + if do_expunge: + Session.expunge_all() + Session.commit() + except Exception as e: + # Only the exceptions raised by session.commit above are caught here + Session.rollback() + raise e + finally: + Session.remove() + + +def initialize_db(application_name: str, config: PostgresConfig): + """ + Initialize the database connection by creating the engine and configuring + the default session maker. + """ + LOGGER.info("Connecting to PostgresDB at %s:%s as user %s", config.host, config.port, config.user_name) + url = URL.create( + "postgresql+psycopg2", + username=config.user_name, + password=config.password, + host=config.host, + port=config.port, + database=config.database_name, + ) + + engine = create_engine( + url, + pool_size=20, + max_overflow=5, + echo=True, + connect_args={ + "application_name": application_name, + "options": "-c lock_timeout=30000 -c statement_timeout=300000", # 5 minutes + }, + ) + + # Bind the global session to the actual engine. + Session.configure(bind=engine) + + return engine diff --git a/src/omotes_orchestrator/dbmodels.py b/src/omotes_orchestrator/dbmodels.py new file mode 100644 index 0000000..9cd18db --- /dev/null +++ b/src/omotes_orchestrator/dbmodels.py @@ -0,0 +1,31 @@ +from dataclasses import dataclass +from enum import Enum + +import sqlalchemy as db +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.dialects.postgresql import UUID + +Base = declarative_base() + + +class JobStatus(Enum): + REGISTERED = "registered" + RUNNING = "running" + FINISHED = "finished" + ERROR = "error" + STOPPED = "stopped" + + +@dataclass +class Job(Base): + __tablename__ = "job" + + job_id = db.Column(UUID(as_uuid=True), primary_key=True) + work_flow_type = db.Column(db.String, nullable=False) + status = db.Column(db.Enum(JobStatus), nullable=False) + input_config = db.Column(db.String) + input_esdl = db.Column(db.String, nullable=False) + output_esdl = db.Column(db.String) + added_at = db.Column(db.DateTime(timezone=True), nullable=False) + running_at = db.Column(db.DateTime(timezone=True)) + stopped_at = db.Column(db.DateTime(timezone=True)) diff --git a/src/omotes_orchestrator/main.py b/src/omotes_orchestrator/main.py new file mode 100644 index 0000000..695a54d --- /dev/null +++ b/src/omotes_orchestrator/main.py @@ -0,0 +1,108 @@ +import logging +import pickle +import signal +import threading + +import jsonpickle +from omotes_job_tools.messages import StatusUpdateMessage, TaskStatus, CalculationResult +from omotes_sdk_protocol.job_pb2 import JobSubmission, JobResult +from omotes_sdk.config import RabbitMQConfig +from omotes_sdk.job import Job +from omotes_sdk.orchestrator_interface import OrchestratorInterface +from omotes_sdk.workflow_type import WorkflowTypeManager, WorkflowType +from omotes_job_tools.broker_interface import BrokerInterface as JobBrokerInterface + +from omotes_orchestrator.celery_interface import CeleryInterface, PostgreSQLConfig + + +logger = logging.getLogger("omotes_orchestrator") + + +class Orchestrator: + omotes_if: OrchestratorInterface + jobs_broker_if: JobBrokerInterface + celery_if: CeleryInterface + + def __init__( + self, + omotes_orchestrator_if: OrchestratorInterface, + jobs_broker_if: JobBrokerInterface, + celery_if: CeleryInterface, + ): + self.omotes_if = omotes_orchestrator_if + self.jobs_broker_if = jobs_broker_if + self.celery_if = celery_if + + def start(self): + self.celery_if.start() + self.omotes_if.start() + self.omotes_if.connect_to_job_submissions(callback_on_new_job=self.new_job_submitted_handler) + self.jobs_broker_if.start() + self.jobs_broker_if.add_queue_subscription("omotes_task_events", self.task_status_update) + + def stop(self): + self.omotes_if.stop() + self.celery_if.stop() + self.jobs_broker_if.stop() + + def new_job_submitted_handler(self, job_submission: JobSubmission, job: Job) -> None: + logger.info("Received new job %s for workflow type %s", job.id, job_submission.workflow_type) + self.celery_if.start_workflow(job.workflow_type, job.id, job_submission.esdl) + + def task_status_update(self, serialized_message: bytes) -> None: + status_update = StatusUpdateMessage.from_dict(pickle.loads(serialized_message)) + logger.debug( + "Received task status update for task %s (job %s) and new status %s", + status_update.celery_task_id, + status_update.omotes_job_id, + status_update.status, + ) + if status_update.status == TaskStatus.SUCCEEDED: + job = Job( + id=status_update.omotes_job_id, workflow_type=WorkflowType(status_update.task_type, "") + ) # TODO Get workflow from WorkflowManager + result: CalculationResult = jsonpickle.decode(self.celery_if.retrieve_result(status_update.celery_task_id)) + logger.info( + "Received result for job %s through task %s", status_update.omotes_job_id, status_update.celery_task_id + ) + job_result_msg = JobResult( + uuid=str(job.id), + result_type=JobResult.ResultType.SUCCEEDED, + success=JobResult.Succes(output_esdl=result.output_esdl.encode()), + ) + self.omotes_if.send_job_result(job, job_result_msg) + + +def main(): + omotes_rabbitmq_config = RabbitMQConfig(username="omotes", password="somepass1", virtual_host="omotes") + celery_rabbitmq_config = RabbitMQConfig(username="celery", password="somepass2", virtual_host="omotes_celery") + celery_postgresql_config = PostgreSQLConfig( + username="celery", password="somepass3", database="omotes_celery", host="localhost", port=5432 + ) + + workflow_type_manager = WorkflowTypeManager( + possible_workflows=[ + WorkflowType(workflow_type_name="grow_optimizer", workflow_type_description_name="Grow Optimizer") + ] + ) + orchestrator_if = OrchestratorInterface(omotes_rabbitmq_config, workflow_type_manager) + celery_if = CeleryInterface(celery_rabbitmq_config, celery_postgresql_config) + jobs_broker_if = JobBrokerInterface(celery_rabbitmq_config) + orchestrator = Orchestrator(orchestrator_if, jobs_broker_if, celery_if) + + stop_event = threading.Event() + + def _stop_by_signal(sig_num, sig_stackframe): + orchestrator.stop() + stop_event.set() + + signal.signal(signal.SIGINT, _stop_by_signal) + signal.signal(signal.SIGTERM, _stop_by_signal) + signal.signal(signal.SIGQUIT, _stop_by_signal) + + orchestrator.start() + stop_event.wait() + + +if __name__ == "__main__": + main() diff --git a/unit_test/test_main.py b/unit_test/test_main.py new file mode 100644 index 0000000..5498508 --- /dev/null +++ b/unit_test/test_main.py @@ -0,0 +1,35 @@ +from datetime import datetime +import unittest +from omotes_orchestrator import main + + +class MyTest(unittest.TestCase): + def test__testable_function__is_correct(self) -> None: + # Arrange + current_time = datetime(1970, 1, 1, 13, 00) + + # Act + result = main.testable_function(current_time) + + # Assert + expected_result = datetime(1970, 1, 1, 14, 00) + self.assertEqual(expected_result, result) + + def test_return_hello_world(self) -> None: + # testing default argument value + expected_result = main.return_hello_world() + self.assertEqual(expected_result, "level=(info): Hello, world!") + + # testing different variations of the input argument + expected_result = main.return_hello_world("debug") + self.assertEqual(expected_result, "level=(debug): Hello, world!") + expected_result = main.return_hello_world("error") + self.assertEqual(expected_result, "level=(error): Hello, world!") + expected_result = main.return_hello_world("warning") + self.assertEqual(expected_result, "level=(warning): Hello, world!") + + # Testing invalid input and error handling + with self.assertRaises(ValueError) as context: + expected_result = main.return_hello_world("nope") + + self.assertTrue("Value nope is not a valid log level." in str(context.exception))