Klass

Klass is Statistics Norway's system for classifications and code lists. The data model is based on the structure and principles described by GSIM.

The information in Klass is exposed through a REST API, available to all, free of charge under the CC BY 4.0 license. The API documentation is available in multiple flavours:

• API Guide: https://data.ssb.no/api/klass/v1/api-guide.html
• Swagger UI: https://data.ssb.no/api/klass/swagger-ui/index.html
• OpenAPI spec: https://data.ssb.no/api/klass/v3/api-docs

Overview

Klass consists of 4 maven modules

• Klass API (Standalone application that provides the Klass API)
• Klass Forvaltning (Internal tool for maintenance of classifications)
• Klass Shared (Classes shared between API and Forvaltning. primary database and search components)
• Klass Solr (Solr Core configuration and configuration for embedded solr for test/development)
• Klass Index Job (Responsible for periodically updating the OpenSearch index)

Build

Run mvn install to build the project.

Deploy

Klass is hosted on the Nais application platform. Deploy configuration may be found in the .nais directory. Deploy workflows may be found in the .github/workflows directory.

Release

The release process is automated. It can be triggered by following these steps:

1. Check that you are on the default branch.
2. Check that you don't have any local commits or changes.
3. Run one of the following commands depending on what version you wish to release make release-patch, make release-minor, make release-major. This command creates or switches to a branch called release and bumps the version number in version.txt. Commit the changes and create a PR. Once this is merged, it triggers a workflow to run the release process like so:
   1. The project is built
   2. The artifacts are deployed
   3. A tag is pushed
   4. The project is reset for the next development iteration
   5. A GitHub release is created which triggers deploy to the prod environment

This command pushes the current state of origin/master as well as locally committed changes to the release branch. This starts a workflow that performs a minor version bump, a GitHub release, and a deployment to the NAIS production environment.

Database

Klass uses PostgreSQL for its database.

Tests are run with the Zonky Postgres embedded database so that they use the PostgreSQL dialect and guarantee consistency with deployed environments.

Klass is configured to use Flyway for database initialization and migration. You can find the collection of SQL scripts in the Klass-shared module under src/main/resources/db/migration

Development

Requirements

• Maven: https://maven.apache.org/install.html
• Sdkman: https://sdkman.io/install
• Java 17: sdk install java 17.0.15-tem
• Java 8 (for Klass Forvaltning): sdk install java 8.0.452-tem

Code Quality configuration

We follow a multi-layered approach based on the "shift-left" philosophy where problems are addressed as early as possible, ideally while writing the code in the IDE. Checks are performed at three stages:

• In the IDE through extensions
• In CI/CD as a hard check on PRs

Developers are encouraged to install the IDE plugins/extensions to avoid pain at the PR stage.

Plugins/extensions

IntelliJ

• https://plugins.jetbrains.com/plugin/7973-sonarqube-for-ide
• https://plugins.jetbrains.com/plugin/8527-google-java-format

Lint

We use Sonarqube for linting. This runs a range of checks on code quality. It runs in CI/CD and it's a good idea to install the extension in your IDE to get feedback as you code.

Formatting

We use google-java-format for code formatting. This avoids unproductive discussions about minutiae of bracket placement etc. Make sure the plugin is installed in your IDE (see above).

It's worth running mvn fmt:format before opening a PR to avoid any chance of a CI check complaining at you.

Configuration

GitHub Packages

In order to download dependencies from GitHub Packages we must authenticate Maven. See the documentation here: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token

This may be done by generating a Personal Access Token (classic) on GitHub with the write:packages scope. Remember to configure SSO. The following configuration may then be placed in your ~/.m2/settings.xml file.

<servers>
    <server>
        <id>github</id>
        <username>USERNAME</username>
        <password>TOKEN</password>
    </server>
</servers>

Docker

Colima on Mac

Colima should have at least 5G memory and the project folder must be mounted. Change this in ~/.colima/default/colima.yaml e.g.

memory: 5
...
mounts:
  - location: /Users/perolsen/Repository/github/klass
    writable: false

Introduction

It's recommended to build with maven before starting development as some classes are generated as part of the build process.

Each app has an .sdkmanrc file which may be used to configure the Java version to use. This may be activated by entering the directory and running the sdk env command. A Makefile is also provided with relevant commands for building each app. See https://sdkman.io/usage#env-command for more details

Klass API

Build

Build the app: make build-klass-api

Docker compose

The apps can be run in multiple different configurations with Docker Compose. See klass-shared/docker-compose.yaml for details.

There are tasks available in the Makefile as well.

Klass Forvaltning

Build

make build-klass-forvaltning

Run

make run-klass-forvaltning-local

Visit http://127.0.0.1:8081/klassui

Spring profiles

Klass API and Klass Forvaltning utilize Spring boot and heavily rely on Spring Profiles to make development and debugging easier. below is a quick summary of the profiles available (see application.properties for more details)

# Application profiles:
#----------------------
# Profiles for production
#   production          = no test beans and only Active Directory login
#
# Profiles for development
#   ad-offline          = will only use test/embeded AD (apacheDS) [Forvaltning only]
#   small-import        = imports a small number of classifications from legacy system, useful during development
#   mock-mailserver     = outgoing emails are only logged

Build profiles

The profile named documentation will generate API documentation with AsciiDoc (default: enabled)

Run / Debug

You can start an application using maven with the following command

mvn spring-boot:run

Start the forvaltning app with

make run-klass-forvaltning-local

Or from your IDE using the KlassApiApplication / KlassForvaltningApplication classes. IntelliJ is recommended, it makes it very easy to start spring boot applications and will make sure your run/debug configuration has all the necessary dependencies (will include maven dependencies with provided scope).

Frontend may be accessed at:

http://localhost:8081/klassui

REST api documentation may be accessed at

http://localhost:8081/api/klass/v1/api-guide.html