✨ Add common simcore-service executable alias

[mrnicegyu11]

What do these changes do?

What

We add an(other) alias for the gunicorn simcore-service executable placed in .venv/bin/ for simcore services.

Previously, the naming convention was simcore-service-$SERVICE_NAME, like simcore-service-storage

Now, we add the generic simcore-service to all services.

Bonus: Harmonized naming, some executables would be named osparc-, which is removed in favor of simcore-service-

Why

In the ops CI/CD we have introduced a CI to validate that the pydantic settings validation passes for a given set of environment variables:

• example pipeline run: https://git.speag.com/oSparc/osparc-ops-deployment-configuration/-/jobs/3849540
• code: https://github.com/ITISFoundation/osparc-ops-environments/blob/main/scripts/deployments/validate_simcore_stack_yml.bash

This CI pipeline calls the settings subcommand of the simcore-executables to validate the configuration. In order to call the executable, the correct name of the service-executable (e.g. simcore-service-storage) has to be known and composed. It is not always easy to do this in a bash script with only a docker-compose.yml given, since for example the webserver runs in different flavors (GC, EVENTS), and has different names for the flavors' docker containers while the gunicorn executables' names remain the same.

By introducing the common alias simcore-service, which is added to $PATH as well, the CI pipeline can be coded more cleanly by checking for the existence of an executable called simcore-service and using it if it exists.

Perspectives

In this direction, we could potentially harmonize the files

- Dockerfile
- entrypoint.sh
- boot.sh

to have only one version of those for all simcore services, instead of duplicating them for every simcore microservice.

Related issue/s

• Incorporate simcore's settings library to validate-env-vars osparc-ops-environments#244
• Add: validate simcore stack yml bash script - to be used in CI/CD osparc-ops-environments#441

How to test

Dev Checklist

• No ENV changes or I properly updated ENV (read the instruction)

DevOps Checklist

[codecov]

Codecov Report

Merging #5051 (9d44570) into master (d410cf7) will increase coverage by 0.2%.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff            @@
##           master   #5051     +/-   ##
========================================
+ Coverage    87.3%   87.5%   +0.2%     
========================================
  Files        1259    1130    -129     
  Lines       51784   47927   -3857     
  Branches     1111     672    -439     
========================================
- Hits        45210   41951   -3259     
+ Misses       6334    5828    -506     
+ Partials      240     148     -92     

Flag	Coverage Δ
integrationtests	64.8% <ø> (-0.1%)	⬇️
unittests	85.1% <ø> (+<0.1%)	⬆️

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

Files	Coverage Δ
...ation/src/service_integration/commands/metadata.py	100.0% <ø> (ø)

... and 135 files with indirect coverage changes

[mrnicegyu11]

Goes with ITISFoundation/osparc-ops-environments#446

[pcrespov]

I think it is a good idea since we do not install more than one service at a time.
I would just like to ask for an extra cleanup and adding a test to constraint docker-compose

thx!

[GitHK]

I'm OK with them, but I have no opinion on the change

[matusdrobuliak66]

👍

[bisgaard-itis]

Looks good to me

[sanderegg]

all good. thank you

[sanderegg]

all good. thank you

[pcrespov]

thx!

[sanderegg]

You should actually revert everything regarding the gateway-server

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[codeclimate]

Code Climate has analyzed commit 9d44570 and detected 0 issues on this pull request.

View more on Code Climate.