Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is1884/using integration library #40

Merged

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Dec 4, 2020

What do these changes do?

Simplifies the service project resulting from this cookiecutter by delegating tooling and standard testing to osparc-simcore's service library or ooil in short.

We have moved most of the code in the cookiecutter to ooil library (which lives in osparc-simcore repo). The idea is that there is now a single source of truth : basically the metadata.yml and docker-compose-build.yml files. Then ooil can deduce everything from it.

Next iteration will introduce the .osparc folder approach (but one step at time :-) )

This leads to a much simpler layout! Just FYI, the resulting service project, compared to the previous version :

  • removes tools folder code
  • removes versioning folder
  • removes VERSION files (can be regenerated with ooil
  • replaces test code by assert_* helper functions ( test skeleton is maintained in this iteration but could be further simplified)
  • moved gitlab/github specific routines in ci to .gitlab and .github folders resp
  • improved Makefile recipes ( w/o breaking the interface in this iteration)

How to test

Could you please try this with one of your services? To create a service project using this cookiecutter + python 3.9 just

$ cookiecutter --checkout=is1884/using-integration-library gh:pcrespov/cookiecutter-osparc-service

Then cd the "baked" project and

$ ls -la
$ make devenv 
$ source .venv/bin/activate
$ ooil --version
$ make build
$ make tests

# then can try other recipes
$ make help
$ make VERSION
$ make replay

Related issue number

Checklist

  • change version
  • add reference to master
  • fix failing tests: issue with source-ing in a subprocess! (@sanderegg any idea on test_bake_project.py issue?)
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you design a new module, add your user to .github/CODEOWNERS

@pcrespov pcrespov changed the title Is1884/using integration library WIP: Is1884/using integration library Dec 16, 2020
@pcrespov pcrespov added this to the Alfred_Büchi milestone Dec 16, 2020
@pcrespov pcrespov self-assigned this Dec 16, 2020
@pcrespov pcrespov added the enhancement New feature or request label Dec 16, 2020
@pcrespov pcrespov marked this pull request as ready for review December 16, 2020 21:16
@sanderegg sanderegg removed their request for review November 26, 2021 15:14
@pcrespov pcrespov force-pushed the is1884/using-integration-library branch 2 times, most recently from 9a5397f to 2d40c36 Compare October 11, 2022 18:14
@pcrespov pcrespov force-pushed the is1884/using-integration-library branch from 804afef to 68e0821 Compare October 13, 2022 17:45
@pcrespov pcrespov requested review from sanderegg and elisabettai and removed request for KZzizzle October 13, 2022 19:11
@pcrespov pcrespov changed the title WIP: Is1884/using integration library Is1884/using integration library Oct 13, 2022
sanderegg
sanderegg previously approved these changes Oct 14, 2022
Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a lot. I see a lot of things hat could be improved:

  • non using docker buildX
  • in the .gitlab folder there are a few deprecated things
  • I guess same is true for .github...
    anyway, very very nice.

.github/CODEOWNERS Outdated Show resolved Hide resolved
.github/workflows/github-ci.yml Show resolved Hide resolved
.vscode/launch.template.json Outdated Show resolved Hide resolved
.vscode/settings.template.json Outdated Show resolved Hide resolved
{{cookiecutter.project_slug}}/Makefile Show resolved Hide resolved
Copy link
Collaborator

@elisabettai elisabettai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very very promising! Looking forward to try it out (I haven't tested yet with your instructions).

@pcrespov pcrespov merged commit 2991408 into ITISFoundation:master Oct 14, 2022
@pcrespov pcrespov deleted the is1884/using-integration-library branch October 14, 2022 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants