Merge pull request #6 from vrk-kpa/ckan-2.11

Ckan 2.11

Author: bzar

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v2
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - name: Install requirements
         run: pip install flake8 pycodestyle
       - name: Check syntax
@@ -19,16 +19,21 @@ jobs:
     needs: lint
     strategy:
       matrix:
-        ckan-version: [2.9, 2.9-py2, 2.8, 2.7]
+        include:
+          - ckan-version: "2.11"
+            ckan-image: "ckan/ckan-dev:2.11-py3.10"
+          - ckan-version: "2.10"
+            ckan-image: "ckan/ckan-dev:2.10-py3.10"
       fail-fast: false
 
     name: CKAN ${{ matrix.ckan-version }}
     runs-on: ubuntu-latest
     container:
-      image: openknowledge/ckan-dev:${{ matrix.ckan-version }}
+      image: ${{ matrix.ckan-image }}
+      options: --user root
     services:
       solr:
-        image: ckan/ckan-solr:${{ matrix.ckan-version }}
+        image: ckan/ckan-solr:${{ matrix.ckan-version }}-solr9
       postgres:
         image: ckan/ckan-postgres-dev:${{ matrix.ckan-version }}
         env:
@@ -46,24 +51,55 @@ jobs:
       CKAN_REDIS_URL: redis://redis:6379/1
 
     steps:
+
       - uses: actions/checkout@v3
+      - name: Setup qsv
+        run: |
+          apt install unzip
+          wget https://github.com/jqnatividad/qsv/releases/download/3.3.0/qsv-3.3.0-x86_64-unknown-linux-musl.zip
+          unzip qsv-3.3.0-x86_64-unknown-linux-musl.zip -d $RUNNER_TEMP/qsvbin
+          echo "$RUNNER_TEMP/qsvbin" >> $GITHUB_PATH
+
+      - run: qsv --version
+
       - name: Install requirements
         run: |
-          apk add file
           pip install -r requirements.txt
           pip install -r dev-requirements.txt
           pip install -e .
           # Replace default path to CKAN core config file with the one on the container
           sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini
-      - name: Setup extension (CKAN >= 2.9)
-        if: ${{ matrix.ckan-version != '2.7' && matrix.ckan-version != '2.8' }}
+        
+          # Replace qsv bin to one in path, will produce error in logs
+          sed -i -e 's/ckanext.qa.qsv_bin.*/ckanext.qa.qsv_bin = qsv/' test.ini      
+      
+      - name: Setup extension
         run: |
           ckan -c test.ini db init
-          ckan -c test.ini qa init
-      - name: Setup extension (CKAN < 2.9)
-        if: ${{ matrix.ckan-version == '2.7' || matrix.ckan-version == '2.8' }}
-        run: |
-          paster --plugin=ckan db init -c test.ini
-          paster --plugin=ckanext-qa qa init -c test.ini
+          ckan -c test.ini db upgrade -p qa
+
       - name: Run tests
-        run: pytest --ckan-ini=test.ini --cov=ckanext.qa --disable-warnings ckanext/qa/tests
+        run: pytest --ckan-ini=test.ini --cov=ckanext.qa --disable-warnings ckanext/qa/tests --junitxml=junit.xml -o junit_family=legacy
+
+      - name: install codecov requirements
+        run: |
+          apt-get update
+          apt-get install -y curl gpg
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        if: ${{ !cancelled() }}
+        continue-on-error: true #don't fail if we can't upload (ie a fork that does not have integration plugged in)
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: false # optional (default = false)
+          flags: ckan-${{ matrix.ckan-version }}
+
+      - name: Upload test results to Codecov
+        uses: codecov/test-results-action@v1
+        if: ${{ !cancelled() }}
+        continue-on-error: true #don't fail if we can't upload (ie a fork that does not have integration plugged in)
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: false # optional (default = false)
+          flags: ckan-${{ matrix.ckan-version }}

README.rst

@@ -32,6 +32,7 @@ Requirements
 Before installing ckanext-qa, make sure that you have installed the following:
 
 * CKAN 2.1+ (tests are only running for CKAN 2.7+)
+* QSV (https://github.com/dathere/qsv) identifying files
 * ckanext-archiver 2.0+ (https://github.com/ckan/ckanext-archiver)
 * ckanext-report (https://github.com/datagovuk/ckanext-report) for reporting
 
@@ -59,13 +60,15 @@ To install ckanext-qa, ensure you have previously installed ckanext-archiver (v2
 
 4. Now create the database tables::
 
-     paster --plugin=ckanext-qa qa init --config=production.ini
+     ckan -c ckan.ini qa init
 
 5. Add ``qa`` to the ``ckan.plugins`` setting BEFORE ``archiver`` in your CKAN
    config file (by default the config file is located at
-   ``/etc/ckan/default/production.ini``).
+   ``/etc/ckan/default/ckan.ini``).
+
+6. Add ``qsv`` binary path to ``ckanext.qa.qsv_bin`` config variable.
 
-6. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
+7. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
 
      sudo service apache2 reload
 

ckanext/qa/cli.py

@@ -61,6 +61,7 @@ def update(ids, queue):
 
 @qa.command()
 @click.argument('filepaths', nargs=-1)
+@click.option('-f', '--filepaths', help='Filepaths to sniff')
 def sniff(filepaths):
     if len(filepaths) < 1:
         print('Not enough arguments', filepaths)

ckanext/qa/config_declaration.yaml

@@ -0,0 +1,7 @@
+version: 1
+groups:
+  - annotation: QA settings
+    options:
+      - key: ckanext.qa.qsv_bin
+        description: Path to QSV binary
+        default: /usr/local/bin/qsv

ckanext/qa/lib.py

@@ -2,13 +2,16 @@
 import json
 import re
 import logging
-from ckan.plugins.toolkit import config
+from ckan.plugins import toolkit as tk
 
 from ckan import plugins as p
 from ckanext.qa.tasks import update_package, update
 
 log = logging.getLogger(__name__)
 
+config = tk.config
+enqueue_job = tk.enqueue_job
+
 _RESOURCE_FORMAT_SCORES = None
 
 
@@ -19,10 +22,11 @@ def compat_enqueue(name, fn, queue, args=None):
     '''
     try:
         # Try to use RQ
-        from ckan.plugins.toolkit import enqueue_job
+        log.debug('Trying to use RQ')
         enqueue_job(fn, args=args, queue=queue)
     except ImportError:
         # Fallback to Celery
+        log.debug('RQ not installed, falling back to Celery')
         import uuid
         from ckan.lib.celery_app import celery
         celery.send_task(name, args=args + [queue], task_id=str(uuid.uuid4()))
@@ -87,7 +91,7 @@ def munge_format_to_be_canonical(format_name):
 def create_qa_update_package_task(package, queue):
 
     compat_enqueue('qa.update_package', update_package, queue,  args=[package.id])
-    log.debug('QA of package put into celery queue %s: %s',
+    log.debug('QA of package put into queue %s: %s',
               queue, package.name)
 
 
@@ -99,5 +103,5 @@ def create_qa_update_task(resource, queue):
 
     compat_enqueue('qa.update', update, queue, args=[resource.id])
 
-    log.debug('QA of resource put into celery queue %s: %s/%s url=%r',
+    log.debug('QA of resource put into queue %s: %s/%s url=%r',
               queue, package.name, resource.id, resource.url)

ckanext/qa/migration/qa/README

@@ -0,0 +1 @@
+Generic single-database configuration.

ckanext/qa/migration/qa/alembic.ini

@@ -0,0 +1,74 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = %(here)s
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to /srv/app/ckanext/ckanext-qa/ckanext/qa/migration/qa/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat /srv/app/ckanext/ckanext-qa/ckanext/qa/migration/qa/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

ckanext/qa/migration/qa/env.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+from ckan.model.meta import metadata
+
+import os
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+name = os.path.basename(os.path.dirname(__file__))
+
+
+def include_object(object, object_name, type_, reflected, compare_to):
+    if type_ == "table":
+        return object_name.startswith(name)
+    return True
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+
+    url = config.get_main_option(u"sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=target_metadata, literal_binds=True,
+        version_table=u'{}_alembic_version'.format(name),
+        include_object=include_object,
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix=u'sqlalchemy.',
+        poolclass=pool.NullPool)
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            version_table=u'{}_alembic_version'.format(name),
+            include_object=include_object,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

ckanext/qa/migration/qa/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}