La solution qui vous identifie en tant que professionnel.
This repository contains 3 main folders:
- docker: the custom docker environnement called "docker stack"
- back: the Node.js source code
- quality: the end-to-end tests
This guide provides steps to run the ProConnect Fédération within a custom docker environnement called "docker stack".
- Node.js (v22) installed (we suggest the usage of nvm)
- Yarn (>= 1.22) installed (doc)
- Docker (>= v20.04) and Docker Compose (>= v2.0) installed (doc)
brew install bash
brew install coreutilsInstall the latest version of bash. Install coreutils gives you access to the timeout function.
Now we will set up the working environment for the docker-stack.
- Add the following lines to your
~/.bashrc:
# change /path/to/france/connect/workspace/ by actual path to your working directory:
export PC_ROOT=/path/to/proconnect/workspace/
# Workaround for UnixHTTPConnectionPool(host='localhost', port=None): Read timed out. (read timeout=70) :
export COMPOSE_HTTP_TIMEOUT=200
# Makes cypress aware of root path, not having to create relative path from e2E test file
export CYPRESS_PC_ROOT=$PC_ROOT
# Setup the docker registry url (for now, we still continue to use the ProConnect container registry)
export PC_DOCKER_REGISTRY=ghcr.io/proconnect-gouv/federation
# Alias for the docker-stack command (you can add it to your "~/.bash_aliases" if you prefer but don't forget to set the variables before the .bash_aliases sourcing in your .bashrc 😉) :
alias dks=$PC_ROOT/federation/docker/docker-stack- Clone the repository
mkdir -p $PC_ROOT && cd $PC_ROOT
git clone git@github.com:proconnect-gouv/federation.gitdks switch smallOn https://fsa1-low.docker.dev-franceconnect.fr/, you can test the connexion with: test@fia1.fr
You are now connected to fsa1!
ProConnect Federation Admin was formerly named fc-exploitation.
Start it with:
dks switch mediumThen go to https://exploitation-fca-low.docker.dev-franceconnect.fr/login.
Login with:
- Username:
jean_moust - Password:
georgesmoustaki - TOTP: enter this secret in your totp app
KVKFKRCPNZQUYMLXOVYDSQKJKZDTSRLD
More credentials can be found here : federation-admin/shared/fixtures/User.yml.
You will then find a list of accessible URLs here: https://hello.docker.dev-franceconnect.fr.
Most URLs follow the same pattern .docker.dev-franceconnect.fr
On any URL, if you got a 502, it might still be booting, wait one minute, then reload.
File based logs are stored here:
federation/docker/volumes/log
You can read them with:
tail -F $PC_ROOT/federation/docker/volumes/log/* | npx pino-prettyOther logs are outputted in stdout. You can read them with, for example:
docker compose logs core -f --no-log-prefix | npx pino-prettyBy default, only the core-fca service runs in watch mode. To apply changes to either the idp, sp or data provider, execute the following command:
dks start fia1-lowYou might also need to restart the reverse proxy:
dks compose restart rp-all
dks haltdks compose down --volumes --remove-orphans --rmi alldks helpThese tests are included directly in source code rather than in a dedicated test folder.
ProConnect expects 100% code coverage. You can test the coverage using the following commands.
cd $PC_ROOT/federation/back
yarn test --coverage --maxWorkers=50%
cd $PC_ROOT/federation/admin
yarn testIf you want to check the coverage for a single file:
yarn test:cov --collectCoverageFrom=path/to/file.ts path/to/file.spec.tsTo execute the unit tests faster, you can run them without coverage.
yarn testcd $PC_ROOT/federation/quality/fca
yarn installdks switch medium
cd $PC_ROOT/federation/quality/fca
yarn start:lowdks switch medium
cd $PC_ROOT/federation/admin
yarn test:e2e:opendks switch medium
cd $PC_ROOT/federation/quality/fca
yarn test:low:chrome-desktop --env TAGS='not @hybridge and not @ignore'dks switch hybridge
cd $PC_ROOT/federation/quality/fca
yarn test:low:chrome-desktop --env TAGS='@hybridge'dks switch small
cd $PC_ROOT/federation/quality/fca
yarn test:low:snapshotcd $PC_ROOT/federation/quality/fca
yarn lint --fix
yarn prettier --write
cd $PC_ROOT/federation/back
yarn doc
yarn lint --fix
yarn prettier --write
yarn tsc --noEmit
cd $PC_ROOT/federation/admin
yarn lint --fixcd $PC_ROOT/federation/quality/fca
# Get the credentials from a team member
CYPRESS_TEST_ENV=integ01 CYPRESS_EXPLOIT_USER_NAME=proconnect-test-local CYPRESS_EXPLOIT_USER_PASS='xxx' CYPRESS_EXPLOIT_USER_TOTP='xxx' yarn start:lowWe use migrate-mongo to manage the database migrations.
# in the back directory
$ yarn run migrate create "blacklist the beatles"
Created: migrations/20250203153126-blacklist_the_beatles.ts
Done in 0.25s.Note
The generated file does really match our code style and might not be very TypeScript friendly.
Feel free to change it to guaranty type safety.
The files will run with NODE_OPTIONS="--experimental-strip-types" for a year (2024) as Node.js 24 is will have this option active by default.
We use init containers to run the migration script on the mongo container.
To run core-fca-low migration script, run:
$ docker compose run --rm init-coreNote
This init-core-fca-low container is a dependency of the core-fca-low container.
It will run the migration script every time the core-fca-low container is started.
No need to do it manually when using the dks switch