ci: add workflows

[JaeAeich]

Summary by Sourcery

Introduce a new Task Execution Service (TES) module along with supporting modules for transport, configuration, and service information. Add comprehensive CI workflows for PR evaluation, code testing, and code quality checks. Implement build and test scripts, and add documentation and issue templates.

New Features:

• Introduce a new module for Task Execution Service (TES) with functionalities to create, get, list, and cancel tasks.
• Add a new Transport module to handle HTTP requests with support for GET, POST, PUT, and DELETE methods.
• Implement a new Configuration module to manage API configurations including base path, user agent, and authentication details.
• Add a ServiceInfo module to fetch service information using the new Transport module.

Enhancements:

• Add a build script (build-models.sh) to generate models from OpenAPI specifications.
• Introduce a pre-commit configuration (.pre-commit-config.yaml) to enforce code quality checks.
• Add a markdown lint configuration (.markdownlint.yaml) to enforce consistent markdown styling.
• Add a YAML lint configuration (.yamllint.yaml) to enforce consistent YAML styling.
• Add a nextest configuration (nextest.toml) to manage test retries and setup commands.

Build:

• Add a build script (build-models.sh) to automate the generation of models from OpenAPI specifications.

CI:

• Add a CI workflow (.github/workflows/pr_evaluation.yaml) to evaluate pull requests with checks for merge conflicts, pre-commit hooks, semantic PR titles, and binary builds.
• Add a CI workflow (.github/workflows/code_test.yaml) to run integration and unit tests with coverage reporting.
• Add a CI workflow (.github/workflows/code_quality.yaml) to run formatting, linting, and spell check tasks.

Documentation:

• Add a README.md file with instructions for building the project, running tests, and testing the CI/CD workflow locally.

Tests:

• Add unit tests for the TES module to test task creation, status retrieval, cancellation, and listing.
• Add unit tests for the Transport module to test HTTP request handling.
• Add a test utility module (test_utils.rs) to setup the testing environment and ensure Funnel server is running.

Chores:

• Add a general-purpose issue template (.github/ISSUE_TEMPLATE/general-purpose.md) for reporting issues.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new module for Task Execution Service (TES) with task management and async functions, a Transport module for HTTP requests, and a ServiceInfo module for service information retrieval. It also includes GitHub Actions workflows for PR evaluation, code testing, and code quality checks, along with configuration files for markdownlint, pre-commit hooks, and yamllint. Additionally, scripts and configuration for building OpenAPI models and running tests are added.

File-Level Changes

Files	Changes
lib/src/tes/mod.rs lib/src/tes/model.rs	Added a new module for TES (Task Execution Service) with models, task management, and async functions for task operations, including unit tests.
lib/src/transport.rs lib/src/serviceinfo/mod.rs	Added new modules for Transport and ServiceInfo with HTTP request handling and service information retrieval, including unit tests.
.github/workflows/pr_evaluation.yaml .github/workflows/code_test.yaml .github/workflows/code_quality.yaml	Added GitHub Actions workflows for PR evaluation, code testing, and code quality checks.
.markdownlint.yaml .pre-commit-config.yaml .yamllint.yaml	Added configuration files for markdownlint, pre-commit hooks, and yamllint.
build-models.sh run-tests.sh nextest.toml	Added scripts and configuration for building OpenAPI models, running tests, and ensuring the Funnel server is running.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[uniqueg]

Some minor comments, but generally the workflows look really good/useful. Of course needs some changes in the code to pass. Also, perhaps a more Rust-experienced person could look at it, because I don't know the toolchain really. @pavelnikonorov @vemonet

I have added CODECOV_TOKEN.

[uniqueg]

Doesn't have anything to do with CI?

[JaeAeich]

😭 yeah I just wanted to add most of the things that were left from cookiecutter thats it, not just the CI.

[uniqueg]

Fair. But let's make sure to remove this from this PR and add it to another (together with the PR template).

[uniqueg]

Run linting?

[uniqueg]

Add to Cargo.toml?

[JaeAeich]

aah yes, didn't touch that as it wan't merged.

[vemonet]

I think since it is a CLI tool it needs to be installed manually outside of the Cargo.toml, or maybe you can add it to the rust-toolchain file

[uniqueg]

Really? What's the difference? Aren't the deps in Cargo.toml installed via cargo install?

[uniqueg]

Check that all pre-commit hooks passed

[JaeAeich]

🤯 this is what I have in cookiecutter though!!!! Do I have change it there as well?

[vemonet]

Why the need for poetry here?

[JaeAeich]

Please ignore, was copying the structure from a python project, must have been left in. Will remove.

[uniqueg]

Yes, not a biggie of course. You can change it here, and sneak it in some other time in the cookiecutter template, if you remember

[uniqueg]

Ah, yes, overlooked the Poetry artifacts here - good catch @vemonet

[JaeAeich]

@uniqueg either merge this after we have merged all other PRs, because resolving convo will mean me changing some code so it doesn't make sense to do that rn, or merge this into some PR take it from there which might not be ideal though.

[vemonet]

The 2 first lines seems to be running the actual formatting, are they really needed? It seems like we should only be doing fmt check in the workflow no?

[vemonet]

I think you should also add the --doc flag so that tarpaulin includes codeblocks from the docstrings

[vemonet]

Looking good, most things required seems to be there: tests, cov, fmt, linting, precommit

[JaeAeich]

Looking good, most things required seems to be there: tests, cov, fmt, linting, precommit

Thanks for the review, Ill make changes when the branch on which this is bases off of gets merged.

[uniqueg]

Looking good, most things required seems to be there: tests, cov, fmt, linting, precommit

Thanks for the review, Ill make changes when the branch on which this is bases off of gets merged.

"This branch has no conflicts with the base branch" <- I think you could already make the changes? Of course, it may need some other stuff until tests pass, but I do think you could work towards resolving the open issues at this point, @JaeAeich and @aaravm