Util

Various bits of Scala that could be useful for any project.

Concurrency

LimitedExecution and implementations that can wrap functions that return futures and limit the number of functions that are running.

Hash

Hashing algorithms for various object types

IO

IO-related classes. Notably the package includes the function stringToInputStream that will create an InputStream for a string that can greatly aid testing in this area.

Models

Notably includes IdIterator for generating a unique sequence of ids.

Path

DirectoryDeleter

Time

ImplicitOrdering has ordering of LocalDateTime.

Now is a trait that gives the current date time. AdvancingNow is an implementation useful for testing.

For setting a fixed time use:

import io.mdcatapult.util.time.nowUtc
val currentTime = nowUtc.now()
val time: Now = () => currentTime

Logging

Includes an implementation of HMRC's logback json logger licenced under Apache 2.0.
Build was unavailable for scala 2.13 so code is included directly. To use it add the class to your logback.xml file.

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="io.mdcatapult.util.logger.JsonEncoder"/>
    </appender>

To add arbitrary fields to the log output you need to use Logback Mapped Diagnostic Contexts.

import org.slf4j.MDC
MDC.put("a-message", "my message")
MDC.put("another-message", """"{"a-key": "a-value"}"""")

You can add these fields at any time before you output the log message.

Dependency Scanning

https://github.com/albuch/sbt-dependency-check

The sbt-dependency-check plugin can be used to create a HTML report under target/scala-x.x/dependency-check-report.html

sbt dependencyCheck

Fetch dependencies from internal package repository

Make sure your ~/.sbt/.credentials file is set up correctly.

realm=GitLab Packages Registry
host=gitlab.com
user=Private-Token
password=your-private-gitlab-token

Set the REGISTRY_HOST_PROJECT_ID to point to the gitlab internal package repo. ie

export REGISTRY_HOST_PROJECT_ID=12345678

Ask SE for the actual ID you should use. You may need to set it in any env within your run config in your IDE.

If updating sbt packages, compiling or running tests inside your IDE you will need to add the env var to the sbt setup within it. For example, for intellij go to the settings and add the env var in the Environment Variables field via Build, Execution, Deployment > Build Tools > SBT

License

This project is licensed under the terms of the Apache 2 license, which can be found in the repository as LICENSE.txt