Merge pull request #170 from ckan/2.11-support

CKAN 2.11 support

.github/workflows/test.yml

@@ -4,8 +4,8 @@ jobs:
  lint:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-python@v4
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
  with:
  python-version: '3.10'
  - name: Install requirements
@@ -17,16 +17,16 @@ jobs:
  needs: lint
  strategy:
  matrix:
- ckan-version: ["2.10", 2.9]
+ ckan-version: ["2.11", "2.10", 2.9]
  fail-fast: false
 
  name: CKAN ${{ matrix.ckan-version }}
  runs-on: ubuntu-latest
  container:
- image: openknowledge/ckan-dev:${{ matrix.ckan-version }}
+ image: ckan/ckan-dev:${{ matrix.ckan-version }}
  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:
@@ -44,7 +44,7 @@ jobs:
  CKAN_REDIS_URL: redis://redis:6379/1
 
  steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
  - name: Install requirements
  run: |
  pip install -r requirements.txt
@@ -56,8 +56,5 @@ jobs:
  run: |
  ckan -c test.ini db init
  - name: Run tests
- run: pytest --ckan-ini=test.ini --cov=ckanext.showcase --cov-report=xml --cov-append --disable-warnings ckanext/showcase/tests
- - name: Upload coverage report to codecov
- uses: codecov/codecov-action@v1
- with:
- file: ./coverage.xml
+ run: pytest --ckan-ini=test.ini --cov=ckanext.showcase --cov-report=term-missing --cov-append --disable-warnings ckanext/showcase/tests
+

README.rst

@@ -30,7 +30,7 @@ ckanext-showcase is intended to be a more powerful replacement for the
 Requirements
 ------------
 
-Tested on CKAN 2.9 and 2.10.
+Tested on CKAN 2.9 to 2.11.
 
 Note: Use `1.5.2` for older CKAN versions (2.7 and 2.8).
 
@@ -56,11 +56,13 @@ To install ckanext-showcase:
  config file (by default the config file is located at
  ``/etc/ckan/default/production.ini``).
 
-4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
+4. Create the database tables::
 
-  sudo service apache2 reload
+ ckan db upgrade -p showcase
 
 
+5. Restart CKAN. 
+
 ------------------------
 Development Installation
 ------------------------

ckanext/showcase/migration/showcase/README

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

ckanext/showcase/migration/showcase/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 /home/adria/dev/pyenvs/ckan-211/ckanext-showcase/ckanext/showcase/migration/showcase/versions. When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat /home/adria/dev/pyenvs/ckan-211/ckanext-showcase/ckanext/showcase/migration/showcase/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/showcase/migration/showcase/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/showcase/migration/showcase/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"}

ckanext/showcase/migration/showcase/versions/02b006cb222c_add_ckanext_showcase_tables.py

@@ -0,0 +1,56 @@
+"""Add ckanext-showcase tables
+
+Revision ID: 02b006cb222c
+Revises:
+Create Date: 2024-07-12 12:04:18.803072
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "02b006cb222c"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ engine = op.get_bind()
+ inspector = sa.inspect(engine)
+ tables = inspector.get_table_names()
+ if "showcase_package_association" not in tables:
+ op.create_table(
+ "showcase_package_association",
+ sa.Column(
+ "package_id",
+ sa.UnicodeText,
+ sa.ForeignKey("package.id", ondelete="CASCADE", onupdate="CASCADE"),
+ primary_key=True,
+ nullable=False,
+ ),
+ sa.Column(
+ "showcase_id",
+ sa.UnicodeText,
+ sa.ForeignKey("package.id", ondelete="CASCADE", onupdate="CASCADE"),
+ primary_key=True,
+ nullable=False,
+ ),
+ )
+ if "showcase_package_association" not in tables:
+ op.create_table(
+ "showcase_admin",
+ sa.Column(
+ "user_id",
+ sa.UnicodeText,
+ sa.ForeignKey("user.id", ondelete="CASCADE", onupdate="CASCADE"),
+ primary_key=True,
+ nullable=False,
+ ),
+ )
+
+
+def downgrade():
+ op.drop_table("showcase_package_association")
+ op.drop_table("showcase_admin")