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

✨♻️ New version_display and release_date fields for service metadata #5902

Merged

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented May 31, 2024

What do these changes do?

  • ✨ new optional fields for ServiceDockerData, namely version_display and release_date (backwards compatible)
    • ooil can produce labels for the new fields in mimage 'service-integration version: 1.0.3 → 1.0.4'
    • webserver exposes 'services/webserver api version: 0.40.3 → 0.40.4' new fields
  • ♻️ cleanup service-integration
  • ♻️ cleanup models_library.services

Next PR will review and update the entire logic from the registry to the webserver API.

Related issue/s

How to test

cd packages/service-integration
make install-dev
ooil compose -m tests/data/metadata.yml

should produce a docker-compose.yml

version: '3.7'
services:
  osparc-python-runner:
    build:
      context: ./
      dockerfile: Dockerfile
      labels:
        io.simcore.name: '{"name":"Sim4Life Python Runner"}'
        io.simcore.description: '{"description":"Python Runner with Sim4Life"}'
        io.simcore.key: '{"key":"simcore/services/dynamic/osparc-python-runner"}'
        io.simcore.version: '{"version":"1.1.0"}'
        io.simcore.version_display: '{"version_display":"Sim4Life Release V7.2"}'
        io.simcore.release_date: '{"release_date":"2024-05-30"}'
        io.simcore.integration-version: '{"integration-version":"1.0.0"}'
        io.simcore.type: '{"type":"computational"}'
        io.simcore.authors: '{"authors":[{"name":"Mr X","email":"[email protected]","affiliation":"Foo
          & co."},{"name":"Pedro Crespo","email":"[email protected]","affiliation":"Foo
          & co."}]}'
        io.simcore.contact: '{"contact":"[email protected]"}'
        io.simcore.inputs: '{"inputs":{"input_1":{"displayOrder":1.0,"label":"Input
          data","description":"Any code, requirements or data file","type":"data:*/*"}}}'
        io.simcore.outputs: '{"outputs":{"output_1":{"displayOrder":1.0,"label":"Output
          data","description":"All data produced by the script is zipped as output_data.zip","type":"data:*/*","fileToKeyMap":{"output_data.zip":"output_1"}}}}'
        org.label-schema.build-date: '2024-05-31T09:37:19Z'
        org.label-schema.schema-version: '1.0'
        org.label-schema.vcs-ref: 69d667b3e596e7319dfbeb3153e9561cec7eebad
        org.label-schema.vcs-url: [email protected]:pcrespov/osparc-simcore.git
        simcore.service.paths-mapping: '{"inputs_path":"/config/workspace/inputs","outputs_path":"/config/workspace/outputs","state_paths":["/config"]}'
        simcore.service.settings: '[{"name":"resources","type":"Resources","value":{"mem_limit":17179869184,"cpu_limit":1000000000}},{"name":"ports","type":"int","value":8443},{"name":"constraints","type":"string","value":["node.platform.os
          == linux"]}]'
    image: simcore/services/dynamic/osparc-python-runner:1.1.0

Dev-ops checklist

@pcrespov pcrespov self-assigned this May 31, 2024
@pcrespov pcrespov added a:models-library a:ooil integration-library or ooil labels May 31, 2024
Copy link

codecov bot commented May 31, 2024

Codecov Report

Attention: Patch coverage is 71.42857% with 22 lines in your changes are missing coverage. Please review.

Project coverage is 88.1%. Comparing base (cafbf96) to head (b76e14a).
Report is 241 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #5902      +/-   ##
=========================================
+ Coverage    84.5%   88.1%    +3.5%     
=========================================
  Files          10    1110    +1100     
  Lines         214   48266   +48052     
  Branches       25     563     +538     
=========================================
+ Hits          181   42556   +42375     
- Misses         23    5587    +5564     
- Partials       10     123     +113     
Flag Coverage Δ
integrationtests 64.8% <ø> (?)
unittests 85.8% <71.4%> (+1.2%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...src/models_library/api_schemas_catalog/services.py 100.0% <100.0%> (ø)
...ages/models-library/src/models_library/services.py 91.6% <100.0%> (ø)
...s/models-library/src/models_library/services_db.py 100.0% <100.0%> (ø)
...e_integration/_compose_spec_model_autogenerated.py 100.0% <100.0%> (ø)
...service-integration/src/service_integration/cli.py 84.0% <100.0%> (ø)
...ation/src/service_integration/commands/metadata.py 100.0% <100.0%> (ø)
...egration/src/service_integration/oci_image_spec.py 93.2% <100.0%> (ø)
...tegration/src/service_integration/osparc_config.py 91.8% <100.0%> (ø)
...tion/src/service_integration/osparc_image_specs.py 94.1% <100.0%> (ø)
...ce-integration/src/service_integration/settings.py 100.0% <100.0%> (ø)
... and 10 more

... and 1095 files with indirect coverage changes

@pcrespov pcrespov changed the title Is1404/mai service integration ✨♻️ New fields for service metadata May 31, 2024
@pcrespov pcrespov added this to the Leeroy Jenkins milestone May 31, 2024
@pcrespov pcrespov force-pushed the is1404/mai-service-integration branch from b02d463 to 5e65852 Compare May 31, 2024 10:34
@pcrespov pcrespov marked this pull request as ready for review May 31, 2024 10:35
@pcrespov pcrespov requested review from mguidon and bisgaard-itis May 31, 2024 10:35
@pcrespov pcrespov enabled auto-merge (squash) May 31, 2024 10:35
@pcrespov pcrespov changed the title ✨♻️ New fields for service metadata ✨♻️ New version_display and release_date fields for service metadata May 31, 2024
@pcrespov pcrespov requested a review from elisabettai May 31, 2024 10:39
Copy link
Member

@mguidon mguidon left a comment

Choose a reason for hiding this comment

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

Thanks. @GitHK Are you going to release a new version for the service-integration image? Last time you told me that I shoud not use master-github-latest.

Copy link
Contributor

@matusdrobuliak66 matusdrobuliak66 left a comment

Choose a reason for hiding this comment

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

👍

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.

Nice thanks a lot!

I guess at some point it might be interesting to add also a field for the changelog, not necessary for the current tasks obviously.

And I assume different services can NOT have the same version but can potentially have the same version_display.

@pcrespov
Copy link
Member Author

Nice thanks a lot!

I guess at some point it might be interesting to add also a field for the changelog, not necessary for the current tasks obviously.

And I assume different services can NOT have the same version but can potentially have the same version_display.

@elisabettai more metadata will be added. This is just an initial change to review and update the entire workflow (from creation, parsing, integration, apis, etc). Once is done we will be able to add more

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.

great, thank you. please have a look at the release date vs datetime consideration.

Copy link
Contributor

@GitHK GitHK left a comment

Choose a reason for hiding this comment

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

A couple of observations form me

@pcrespov pcrespov requested a review from GitHK May 31, 2024 13:21
Copy link
Contributor

@bisgaard-itis bisgaard-itis left a comment

Choose a reason for hiding this comment

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

Very nice. Thanks a lot!

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.2% Duplication on New Code

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:models-library a:ooil integration-library or ooil
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants