Merge pull request #7 from arthur-schnitzler/main

tests and some other things

.env

@@ -1,5 +1,5 @@
-POSTGRES_DB=pmb
-POSTGRES_USER=pmb
-POSTGRES_PASSWORD=pmb
-POSTGRES_HOST=172.17.0.1
-DEBUG=True
+POSTGRES_DB=pmb_play
+# NEW_PMB=True
+# POSTGRES_HOST=172.17.0.1
+DEBUG=True
+POSTGRES_HOST=127.0.0.1

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+on: 
+  push:
+jobs:
+  test:
+    name: Test Application
+    runs-on: ubuntu-latest
+    env:
+      POSTGRES_DB: github_actions
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: github_actions
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+    - uses: actions/cache@v3
+      with:
+        path: ${{ env.pythonLocation }}
+        key: ${{ env.pythonLocation }}-${{ hashFiles('requirements.txt') }}
+    - name: Install dependencies
+      run: |
+        pip install --upgrade --upgrade-strategy eager -r requirements_dev.txt
+    - name: Run migrations
+      run: |
+        export NEW_PMB=TRUE
+        python manage.py migrate
+        unset NEW_PMB
+    - name: Run tests
+      run: coverage run manage.py test -v 3
+    - name: Create Coverage Report
+      run: coverage xml
+    - name: "Upload coverage to Codecov"
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{secrets.CODECOV_TOKEN}}
+        file: ./coverage.xml
+        fail_ci_if_error: false

.gitignore

@@ -167,3 +167,4 @@ tmp/
 pmb_dump.sql
 .secret
 play.ipynb
+pmb_play_dump.sql

README.md

@@ -1,6 +1,5 @@
 [![flake8 Lint](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/lint.yml/badge.svg)](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/lint.yml)
-<!-- [![Build and publish Docker image](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/build-deploy.yml) -->
-
+[![Test](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/test.yml/badge.svg)](https://github.com/arthur-schnitzler/pmb-service/actions/workflows/test.yml)
 # PMB-SERVICE
 
 lightweight APIS-PMB instance to generate TEI/XML dumps
@@ -12,4 +11,9 @@ maybe in future also with PMB CRUD included
 
 ### process gnd-beacon
 
-`python manage.py process_beacon --beacon=https://thun-korrespondenz.acdh.oeaw.ac.at/beacon.txt --domain=thun-korrespondenz`
+`python manage.py process_beacon --beacon=https://thun-korrespondenz.acdh.oeaw.ac.at/beacon.txt --domain=thun-korrespondenz`
+
+
+## set up new instance
+
+in order to avoid errors on a new instance you'll need to set an environment variable `PMB_NEW=whatever`. After you run the inital `python manage.py migrate` you should `unset PMB_NEW`

apis_core/api_routers.py

@@ -196,7 +196,6 @@ def generic_serializer_creation_factory():
                 select_related.append(f.name)
 
         class TemplateSerializer(serializers.HyperlinkedModelSerializer):
-
             id = serializers.ReadOnlyField()
             url = serializers.HyperlinkedIdentityField(
                 view_name=f"apis:apis_api:{entity_str.lower()}-detail"
@@ -207,7 +206,6 @@ class TemplateSerializer(serializers.HyperlinkedModelSerializer):
             _app_label = app_label
 
             class Meta:
-
                 model = entity
                 exclude = exclude_lst_fin
 
@@ -269,7 +267,6 @@ def __init__(self, *args, **kwargs):
         ) = f"{entity_str.title().replace(' ', '')}Serializer"
 
         class TemplateSerializerRetrieve(TemplateSerializer):
-
             if entity_str.lower() == "text":
                 text = serializers.SerializerMethodField(
                     method_name="txt_serializer_add_text"
@@ -447,14 +444,12 @@ def __init__(self, *args, **kwargs):
                         filter_fields[f1[0]] = f1[1]
 
         class MetaFilter(object):
-
             model = entity
             fields = filter_fields
 
         filterset_dict["Meta"] = MetaFilter
 
         class TemplateViewSet(viewsets.ModelViewSet):
-
             _select_related = select_related
             _prefetch_rel = prefetch_rel
             pagination_class = CustomPagination