Merge pull request #64 from VNG-Realisatie/develop

Develop to master

Author: stevenbal

.travis.yml

@@ -0,0 +1,55 @@
+language: python
+cache: pip
+
+python:
+  - "3.6"
+
+services:
+  - postgresql
+
+addons:
+  postgresql: "10"
+
+env:
+  global:
+    - DJANGO_SETTINGS_MODULE=brc.conf.jenkins
+    - SECRET_KEY=dummy
+    - DB_USER=postgres
+    - DB_PASSWORD=
+    - DEPLOYMENT=brc
+  matrix:
+    - TOXENV=django_tests
+    - TOXENV=isort
+    - TOXENV=black
+
+install:
+  - pip install tox tox-travis
+
+script: tox
+
+jobs:
+  include:
+    # First stage is 'Tests' by default and populated from env matrix
+    # expansion
+    - stage: Docker images
+      name: Test docker image build
+      services:
+        - docker
+      install: skip
+      script:
+        - bash bin/release-docker-image.sh
+      after_success: echo "deploying..."
+      deploy:
+        - provider: script
+          script: bash bin/cicd.sh latest yes
+          on:
+            branch: master
+
+        - provider: script
+          script: bash bin/cicd.sh $TRAVIS_TAG yes
+          on:
+            tags: true
+
+after_success:
+  - pip install codecov
+  - codecov

Dockerfile

@@ -67,6 +67,7 @@ FROM python:3.6-alpine AS production
 RUN apk --no-cache add \
     ca-certificates \
     mailcap \
+    make \
     musl \
     pcre \
     postgresql \
@@ -80,6 +81,7 @@ RUN apk --no-cache add \
 
 COPY --from=build /usr/local/lib/python3.6 /usr/local/lib/python3.6
 COPY --from=build /usr/local/bin/uwsgi /usr/local/bin/uwsgi
+COPY --from=build /usr/local/bin/sphinx-build /usr/local/bin/sphinx-build
 # required for swagger2openapi conversion
 COPY --from=frontend-build /app/node_modules /app/node_modules
 
@@ -91,11 +93,15 @@ RUN mkdir /app/log
 COPY --from=frontend-build /app/src/brc/static/fonts /app/src/brc/static/fonts
 COPY --from=frontend-build /app/src/brc/static/css /app/src/brc/static/css
 COPY ./src /app/src
+COPY ./docs /app/docs
 
 ENV DJANGO_SETTINGS_MODULE=brc.conf.docker
 
 ARG SECRET_KEY=dummy
 
+# build docs
+RUN make -C docs html
+
 # Run collectstatic, so the result is already included in the image
 RUN python src/manage.py collectstatic --noinput
 

README.rst

@@ -7,7 +7,7 @@ besluitregistratiecomponent
 :Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, BRC
 :PythonVersion: 3.6
 
-|build-status|
+|build-status| |black|
 
 Referentieimplementatie van de besluitregistratiecomponent (BRC).
 
@@ -42,14 +42,17 @@ References
 * `Code <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/>`_
 
 
-.. |build-status| image:: http://jenkins.nlx.io/buildStatus/icon?job=gemma-besluitregistratiecomponent-stable
+.. |build-status| image:: https://travis-ci.org/VNG-Realisatie/gemma-besluitregistratiecomponent.svg?branch=develop
     :alt: Build status
-    :target: http://jenkins.nlx.io/job/gemma-besluitregistratiecomponent-stable
+    :target: https://travis-ci.org/VNG-Realisatie/gemma-besluitregistratiecomponent
 
 .. |requirements| image:: https://requires.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/requirements.svg?branch=master
      :target: https://requires.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/requirements/?branch=master
      :alt: Requirements status
 
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+
 .. _testomgeving: https://ref.tst.vng.cloud/brc/
 
 Licentie

bin/cicd.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -u
+
+echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+
+release_tag=$1
+do_deploy=$2
+shift
+
+JOB_NAME=push ./bin/release-docker-image.sh $release_tag
+
+
+deploy() {
+    set +x
+
+    # Trigger deploy
+    curl https://deploy-bot-zgw.vng.cloud/api/v1/deployments \
+        -H "Authorization: Token ${DEPLOY_BOT_TOKEN}" \
+        -H "Content-Type: application/json" \
+        --request POST \
+        --data @- << EOF
+{
+    "name":"${DEPLOYMENT}",
+    "namespace":"zgw",
+    "containerName":"${DEPLOYMENT}",
+    "image": "vngr/besluiten-api:${release_tag}"
+}
+EOF
+    set -x
+
+    echo "Deploy triggered"
+}
+
+
+if [[ $do_deploy == "yes" ]]; then
+    deploy
+fi

bin/docker_start.sh

@@ -42,6 +42,7 @@ uwsgi \
     --module brc.wsgi \
     --static-map /static=/app/static \
     --static-map /media=/app/media  \
+    --static-map /_docs=/app/docs/_build/html \
     --chdir src \
     --processes 2 \
     --threads 2 \

docs/conf.py

@@ -18,7 +18,7 @@
 
 sys.path.insert(0, os.path.abspath('../src'))
 
-os.environ['DJANGO_SETTINGS_MODULE'] = 'brc.conf.dev'
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'drc.conf.dev')
 
 django.setup()
 

requirements/base.in

@@ -1,4 +1,3 @@
-Pillow
 pip-tools
 psycopg2-binary
 python-dotenv
@@ -17,4 +16,4 @@ django-markup==1.3
 django_redis
 
 djangorestframework
-vng-api-common<1.1.0
+vng-api-common

requirements/base.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile --no-index requirements/base.in
+#    pip-compile --no-index --output-file requirements/base.txt requirements/base.in
 #
 alabaster==0.7.12         # via sphinx
 babel==2.6.0              # via sphinx
@@ -19,6 +19,7 @@ django-filter==2.1.0      # via vng-api-common
 django-ipware==2.1.0      # via django-axes
 django-markup==1.3
 django-redis==4.10.0
+django-rest-framework-condition==0.1.1  # via vng-api-common
 django-solo==1.1.3        # via vng-api-common
 django==2.2.8
 djangorestframework-camel-case==0.2.0  # via vng-api-common
@@ -33,12 +34,11 @@ inflection==0.3.1         # via drf-yasg
 iso-639==0.4.5            # via vng-api-common
 isodate==0.6.0            # via vng-api-common
 itypes==1.1.0             # via coreapi
-jinja2==2.10.1            # via coreschema, sphinx
+jinja2==2.11.2            # via coreschema, sphinx
 markdown==3.1
-markupsafe==1.0           # via jinja2
+markupsafe==1.1.1         # via jinja2
 oyaml==0.7                # via vng-api-common
 packaging==19.0           # via sphinx
-pillow==5.2.0
 pip-tools==4.2.0
 psycopg2-binary==2.7.5
 pygments==2.3.1           # via sphinx
@@ -61,7 +61,7 @@ sqlparse==0.3.0           # via django
 unidecode==1.0.22         # via vng-api-common
 uritemplate==3.0.0        # via coreapi, drf-yasg
 urllib3==1.24.3           # via requests
-vng-api-common==1.0.34
+vng-api-common==1.4.4
 
 # The following packages are considered to be unsafe in a requirements file:
 # setuptools==42.0.2        # via markdown, sphinx

requirements/jenkins.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile --no-index --output-file=requirements/jenkins.txt requirements/base.txt requirements/jenkins.in requirements/testing.in
+#    pip-compile --no-index --output-file requirements/jenkins.txt requirements/base.txt requirements/testing.in requirements/jenkins.in
 #
 alabaster==0.7.12
 astroid==1.6.5            # via pylint
@@ -22,6 +22,7 @@ django-ipware==2.1.0
 django-jenkins==0.110.0
 django-markup==1.3
 django-redis==4.10.0
+django-rest-framework-condition==0.1.1
 django-solo==1.1.3
 django==2.2.8
 djangorestframework-camel-case==0.2.0
@@ -40,15 +41,14 @@ iso-639==0.4.5
 isodate==0.6.0
 isort==4.3.4
 itypes==1.1.0
-jinja2==2.10.1
+jinja2==2.11.2
 lazy-object-proxy==1.3.1  # via astroid
 markdown==3.1
-markupsafe==1.0
+markupsafe==1.1.1
 mccabe==0.6.1             # via pylint
 oyaml==0.7
 packaging==19.0
 pep8==1.7.1
-pillow==5.2.0
 pip-tools==4.2.0
 psycopg2-binary==2.7.5
 pygments==2.3.1
@@ -75,8 +75,5 @@ text-unidecode==1.2       # via faker
 unidecode==1.0.22
 uritemplate==3.0.0
 urllib3==1.24.3
-vng-api-common==1.0.34
+vng-api-common==1.4.4
 wrapt==1.10.11            # via astroid
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools==42.0.2        # via markdown, sphinx

src/brc/api/serializers.py

@@ -71,7 +71,7 @@ class Meta:
                     IsImmutableValidator(),
                     PublishValidator(
                         "BesluitType", settings.ZTC_API_SPEC, get_auth=get_ztc_auth
-                    )
+                    ),
                 ]
             },
         }

src/brc/api/tests/test_besluit.py

@@ -2,8 +2,7 @@
 from rest_framework.test import APITestCase
 from vng_api_common.tests import JWTAuthMixin, get_operation_url, get_validation_errors
 
-from brc.datamodel.models import BesluitInformatieObject
-from brc.datamodel.tests.factories import BesluitFactory, BesluitInformatieObjectFactory
+from brc.datamodel.tests.factories import BesluitFactory
 
 from .mixins import MockSyncMixin