Skip to content

Commit

Permalink
Update docker instructions in Makefile and README
Browse files Browse the repository at this point in the history
  • Loading branch information
jwkaltz committed Oct 18, 2023
1 parent bcf3855 commit ac63a81
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -328,12 +328,12 @@ tests: ${VENV_ROOT}/requirements-timestamp test-core test-contrib-print_proxy-ma
.PHONY: docker-tests
docker-tests:
echo "Running tests as user ${LOCAL_UID}:${LOCAL_GID}"
docker-compose run --rm -e PGHOST=oereb-db -e UID=${LOCAL_UID} -e GID=${LOCAL_GID} oereb-server make build lint tests
docker-compose down
docker compose run --rm -e PGHOST=oereb-db -e UID=${LOCAL_UID} -e GID=${LOCAL_GID} oereb-server make build lint tests
docker compose down

.PHONY: docker-clean-all
docker-clean-all:
docker-compose run --rm oereb-make clean-all
docker compose run --rm oereb-make clean-all

.PHONY: check
check: git-attributes lint test
Expand All @@ -354,10 +354,10 @@ updates: $(PIP_REQUIREMENTS)

.PHONY: serve-dev
serve-dev: development.ini build
docker-compose up -d oereb-db
docker compose up -d oereb-db
$(VENV_BIN)/pserve $< --reload

.PHONY: serve
serve: development.ini build
docker-compose up -d oereb-db
docker compose up -d oereb-db
$(VENV_BIN)/pserve $<
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Starting the development server
#. Build run the initial build depending on your OS:

* ``docker network create print-network``
* Linux: ``docker-compose run --rm -u $(id -u):$(id -g) oereb-make build``
* MAC/Windows: ``docker-compose run --rm oereb-make build``
* Linux: ``docker compose run --rm -u $(id -u):$(id -g) oereb-make build``
* MAC/Windows: ``docker compose run --rm oereb-make build``

#. ``docker-compose up``
#. ``docker compose up``

Running ``docker-compose up`` will start the DB (it will automatically import the test/dev data on startup) and start
Running ``docker compose up`` will start the DB (it will automatically import the test/dev data on startup) and start
a running instance of the pyramid_oereb DEV server connected to the DB. The project folder is mounted
to it. So changes take effect.

Expand All @@ -45,8 +45,8 @@ To run the tests locally:
The docker way:
---------------
* ``docker network create print-network``
* Linux: ``docker-compose run --rm -u $(id -u):$(id -g) oereb-server make build tests``
* MAC/Windows: ``docker-compose run --rm oereb-server make build tests``
* Linux: ``docker compose run --rm -u $(id -u):$(id -g) oereb-server make build tests``
* MAC/Windows: ``docker compose run --rm oereb-server make build tests``

For systems having a local make tool, the following recipe can be used:
``make docker-tests``
Expand All @@ -59,7 +59,7 @@ Local tests:
------------
For local tests without the complete docker composition you need a running DB.
You can create one based on the oereb image:
``docker-compose up -d oereb-db``
``docker compose up -d oereb-db``

or create an empty postgis DB
``docker run -p 5555:5432 --name pg_oereb --rm -it -e POSTGRES_PASSWORD=pw postgis/postgis``
Expand All @@ -74,7 +74,7 @@ To run one specfic test:

.. code-block:: bash
docker-compose exec oereb-server PYTEST_OPTS="-k <name_of_the_test>" make tests
docker compose exec oereb-server PYTEST_OPTS="-k <name_of_the_test>" make tests
Troubleshooting
---------------
Expand All @@ -83,14 +83,14 @@ In this case cleanup can be done like:

.. code-block:: bash
docker-compose run --rm oereb-make clean-all
docker compose run --rm oereb-make clean-all
Useful ``make`` targets
=======================

Run the ``make`` targets found in the Makefile either in the ``oereb-server`` container (if using ``docker-compose``) or in your local shell (if running the server locally).
Run the ``make`` targets found in the Makefile either in the ``oereb-server`` container (if using ``docker compose``) or in your local shell (if running the server locally).
Some useful targets:

- ``make serve-dev`` to run the application
Expand All @@ -113,7 +113,7 @@ There are further make targets to check the validity of federal data:
Using MapFish-Print
===================

To be able to test the OEREB static extract (pdf), you need to run ``pyramid_oereb`` with ``docker-compose`` and to have a running instance of `pyramid_oereb_mfp <https://github.com/openoereb/pyramid_oereb_mfp>`__.
To be able to test the OEREB static extract (pdf), you need to run ``pyramid_oereb`` with ``docker compose`` and to have a running instance of `pyramid_oereb_mfp <https://github.com/openoereb/pyramid_oereb_mfp>`__.
The Docker network ``print-network`` is also required and can be created with:

.. code-block:: bash
Expand Down

0 comments on commit ac63a81

Please sign in to comment.