Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| be61a6dfbc | |||
| 7029074c62 | |||
| 5abb6b2204 | |||
| 104636199f | |||
| 9124ccb204 | |||
| 6715354be3 |
12
.github/workflows/release.yml
vendored
Normal file
12
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
uses: swordsteel/hlaeja-common-workflows/.github/workflows/release.yml@master
|
||||
secrets:
|
||||
CI_BOT_PAT: ${{ secrets.CI_BOT_PAT }}
|
||||
with:
|
||||
TYPE: service
|
||||
12
.github/workflows/run-checks.yml
vendored
Normal file
12
.github/workflows/run-checks.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
name: Pull request validation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- '.github/**'
|
||||
|
||||
jobs:
|
||||
validate:
|
||||
uses: swordsteel/hlaeja-common-workflows/.github/workflows/run-checks.yml@master
|
||||
secrets:
|
||||
CI_BOT_PAT: ${{ secrets.CI_BOT_PAT }}
|
||||
11
README.md
11
README.md
@@ -5,7 +5,7 @@ Classes and endpoints, to shape and to steer, Devices and sensors, their purpose
|
||||
## Properties for deployment
|
||||
|
||||
| name | required | info |
|
||||
|----------------------------------------------|:--------:|----------------------------------------------|
|
||||
|-------------------------------|:--------:|------------------------------|
|
||||
| spring.profiles.active | ✓ | Spring Boot environment |
|
||||
| server.port | ✓ | HTTP port |
|
||||
| server.ssl.enabled | ✓ | HTTP Enable SSL |
|
||||
@@ -22,19 +22,12 @@ Classes and endpoints, to shape and to steer, Devices and sensors, their purpose
|
||||
| device-registry.url | ✓ | Device Register URL |
|
||||
| device-data.url | ✓ | Device Data URL |
|
||||
| device-configuration.url | ✓ | Device Configuration URL |
|
||||
| management.influx.metrics.export.api-version | | InfluxDB API version |
|
||||
| management.influx.metrics.export.enabled | | Enable/Disable exporting metrics to InfluxDB |
|
||||
| management.influx.metrics.export.bucket | ✓ | InfluxDB bucket name |
|
||||
| management.influx.metrics.export.org | ✓ | InfluxDB organization |
|
||||
| management.influx.metrics.export.token | ✗ | InfluxDB token |
|
||||
| management.influx.metrics.export.uri | ✓ | InfluxDB URL |
|
||||
| management.metrics.tags.application | ✓ | Application instance tag for metrics |
|
||||
|
||||
*Required: ✓ can be stored as text, and ✗ need to be stored as secret.*
|
||||
|
||||
## Releasing Service
|
||||
|
||||
Run `release.sh` script from `master` branch.
|
||||
Run release pipeline from `master` branch.
|
||||
|
||||
## Development Configuration
|
||||
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
import com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
|
||||
|
||||
plugins {
|
||||
alias(hlaeja.plugins.kotlin.jvm)
|
||||
alias(hlaeja.plugins.kotlin.spring)
|
||||
alias(hlaeja.plugins.ltd.hlaeja.plugin.certificate)
|
||||
alias(hlaeja.plugins.ltd.hlaeja.plugin.service)
|
||||
alias(hlaeja.plugins.spring.boot)
|
||||
alias(hlaeja.plugins.spring.dependency.management)
|
||||
alias(hlaeja.plugins.springframework.boot)
|
||||
alias(hlaeja.plugins.certificate)
|
||||
alias(hlaeja.plugins.service)
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -15,9 +13,8 @@ dependencies {
|
||||
implementation(hlaeja.kotlin.logging)
|
||||
implementation(hlaeja.kotlin.reflect)
|
||||
implementation(hlaeja.kotlinx.coroutines)
|
||||
implementation(hlaeja.micrometer.registry.influx)
|
||||
implementation(hlaeja.library.hlaeja.common.messages)
|
||||
implementation(hlaeja.library.hlaeja.jwt)
|
||||
implementation(hlaeja.library.common.messages)
|
||||
implementation(hlaeja.library.jwt)
|
||||
implementation(hlaeja.springboot.starter.actuator)
|
||||
implementation(hlaeja.springboot.starter.cache)
|
||||
implementation(hlaeja.springboot.starter.redis)
|
||||
@@ -34,17 +31,6 @@ dependencies {
|
||||
|
||||
group = "ltd.hlaeja"
|
||||
|
||||
fun influxDbToken(): String = config.findOrDefault("influxdb.token", "INFLUXDB_TOKEN", "")
|
||||
|
||||
tasks {
|
||||
named("containerCreate", DockerCreateContainer::class) {
|
||||
withEnvVar("MANAGEMENT_INFLUX_METRICS_EXPORT_TOKEN", influxDbToken())
|
||||
}
|
||||
withType<ProcessResources> {
|
||||
filesMatching("**/application.yml") { filter { it.replace("%INFLUXDB_TOKEN%", influxDbToken()) } }
|
||||
onlyIf { file("src/main/resources/application.yml").exists() }
|
||||
}
|
||||
named("processResources") {
|
||||
tasks.named("processResources") {
|
||||
dependsOn("copyCertificates")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
kotlin.code.style=official
|
||||
org.gradle.jvmargs=-Xmx1g
|
||||
version=0.4.0
|
||||
catalog=0.8.0
|
||||
version=0.5.0-SNAPSHOT
|
||||
catalog=0.11.0-SNAPSHOT
|
||||
docker.port.expose=8443
|
||||
container.port.expose=8443
|
||||
container.port.host=9000
|
||||
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
2
gradle/wrapper/gradle-wrapper.properties
vendored
2
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,6 +1,6 @@
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
|
||||
networkTimeout=10000
|
||||
validateDistributionUrl=true
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
|
||||
9
gradlew
vendored
9
gradlew
vendored
@@ -86,8 +86,7 @@ done
|
||||
# shellcheck disable=SC2034
|
||||
APP_BASE_NAME=${0##*/}
|
||||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
|
||||
' "$PWD" ) || exit
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
@@ -115,7 +114,7 @@ case "$( uname )" in #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
CLASSPATH="\\\"\\\""
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@@ -206,7 +205,7 @@ fi
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Collect all arguments for the java command:
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# and any embedded shellness will be escaped.
|
||||
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||
# treated as '${Hostname}' itself on the command line.
|
||||
@@ -214,7 +213,7 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||
"$@"
|
||||
|
||||
# Stop when "xargs" is not available.
|
||||
|
||||
4
gradlew.bat
vendored
4
gradlew.bat
vendored
@@ -70,11 +70,11 @@ goto fail
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
set CLASSPATH=
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
|
||||
5
http/actuator.http
Normal file
5
http/actuator.http
Normal file
@@ -0,0 +1,5 @@
|
||||
### get actuator
|
||||
GET {{hostname}}/actuator
|
||||
|
||||
### get actuator health
|
||||
GET {{hostname}}/actuator/health
|
||||
89
release.sh
89
release.sh
@@ -1,89 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
### This should be a pipeline, but for this example let use this ###
|
||||
|
||||
check_active_branch() {
|
||||
if [ "$(git rev-parse --abbrev-ref HEAD)" != "$1" ]; then
|
||||
echo "Error: The current branch is not $1."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
check_uncommitted_changes() {
|
||||
if [ -n "$(git status --porcelain)" ]; then
|
||||
echo "Error: There are uncommitted changes in the repository."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
prepare_environment() {
|
||||
git fetch origin
|
||||
}
|
||||
|
||||
check_last_commit() {
|
||||
last_commit_message=$(git log -1 --pretty=format:%s)
|
||||
if [ "$last_commit_message" = "[RELEASE] - bump version" ]; then
|
||||
echo "Warning: Nothing to release!!!"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
check_differences() {
|
||||
if ! git diff --quiet origin/"$1" "$1"; then
|
||||
echo "Error: The branches origin/$1 and $1 have differences."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
un_snapshot_version() {
|
||||
sed -i "s/\($1\s*=\s*[0-9]\+\.[0-9]\+\.[0-9]\+\).*/\1/" gradle.properties
|
||||
}
|
||||
|
||||
current_version() {
|
||||
awk -F '=' '/version\s*=\s*[0-9.]*/ {gsub(/^ +| +$/,"",$2); print $2}' gradle.properties
|
||||
}
|
||||
|
||||
stage_files() {
|
||||
for file in "$@"; do
|
||||
if git diff --exit-code --quiet -- "$file"; then
|
||||
echo "No changes in $file"
|
||||
else
|
||||
git add "$file"
|
||||
echo "Changes in $file staged for commit"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
commit_change() {
|
||||
stage_files gradle.properties
|
||||
git commit -m "[RELEASE] - $1"
|
||||
git push --porcelain origin master
|
||||
}
|
||||
|
||||
add_release_tag() {
|
||||
gitTag="v$(current_version)"
|
||||
git tag -a "$gitTag" -m "Release version $gitTag"
|
||||
git push --porcelain origin "$gitTag"
|
||||
}
|
||||
|
||||
snapshot_version() {
|
||||
new_version="$(current_version | awk -F '.' '{print $1 "." $2+1 ".0"}')"
|
||||
sed -i "s/\(version\s*=\s*\)[0-9.]*/\1$new_version-SNAPSHOT/" gradle.properties
|
||||
}
|
||||
|
||||
# check and prepare for release
|
||||
check_active_branch master
|
||||
check_uncommitted_changes
|
||||
prepare_environment
|
||||
check_last_commit
|
||||
check_differences master
|
||||
|
||||
# un-snapshot version for release
|
||||
un_snapshot_version version
|
||||
un_snapshot_version catalog
|
||||
|
||||
# release changes and prepare for next release
|
||||
commit_change "release version: $(current_version)"
|
||||
add_release_tag
|
||||
snapshot_version
|
||||
commit_change 'bump version'
|
||||
@@ -1,8 +1,6 @@
|
||||
package ltd.hlaeja.service
|
||||
|
||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||
import io.micrometer.core.instrument.Counter
|
||||
import io.micrometer.core.instrument.MeterRegistry
|
||||
import java.util.UUID
|
||||
import ltd.hlaeja.library.deviceConfiguration.Node
|
||||
import ltd.hlaeja.property.DeviceConfigurationProperty
|
||||
@@ -18,29 +16,17 @@ private val log = KotlinLogging.logger {}
|
||||
|
||||
@Service
|
||||
class DeviceConfigurationService(
|
||||
meterRegistry: MeterRegistry,
|
||||
private val webClient: WebClient,
|
||||
private val deviceConfigurationProperty: DeviceConfigurationProperty,
|
||||
) {
|
||||
|
||||
private val deviceConfigurationSuccess = Counter.builder("device.configuration.success")
|
||||
.description("Number of successful device configuration calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
private val deviceConfigurationFailure = Counter.builder("device.configuration.failure")
|
||||
.description("Number of failed device configuration calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
suspend fun getConfiguration(
|
||||
node: UUID,
|
||||
): Node.Response = try {
|
||||
webClient.deviceConfigurationGetConfiguration(node, deviceConfigurationProperty)
|
||||
.also { deviceConfigurationSuccess.increment() }
|
||||
} catch (e: ErrorResponseException) {
|
||||
deviceConfigurationFailure.increment()
|
||||
throw e
|
||||
} catch (e: WebClientRequestException) {
|
||||
deviceConfigurationFailure.increment()
|
||||
log.error(e) { "Error device registry" }
|
||||
throw ResponseStatusException(SERVICE_UNAVAILABLE)
|
||||
}
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
package ltd.hlaeja.service
|
||||
|
||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||
import io.micrometer.core.instrument.Counter
|
||||
import io.micrometer.core.instrument.MeterRegistry
|
||||
import java.util.UUID
|
||||
import ltd.hlaeja.library.deviceData.MeasurementData
|
||||
import ltd.hlaeja.property.DeviceDataProperty
|
||||
@@ -20,30 +18,18 @@ private val log = KotlinLogging.logger {}
|
||||
|
||||
@Service
|
||||
class DeviceDataService(
|
||||
meterRegistry: MeterRegistry,
|
||||
private val webClient: WebClient,
|
||||
private val deviceDataProperty: DeviceDataProperty,
|
||||
) {
|
||||
|
||||
private val deviceDataSuccess = Counter.builder("device.data.success")
|
||||
.description("Number of successful device data calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
private val deviceDataFailure = Counter.builder("device.data.failure")
|
||||
.description("Number of failed device data calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
suspend fun getMeasurement(
|
||||
client: UUID,
|
||||
node: UUID,
|
||||
): MeasurementData.Response = try {
|
||||
webClient.deviceDataGetMeasurement(client, node, deviceDataProperty)
|
||||
.also { deviceDataSuccess.increment() }
|
||||
} catch (e: ErrorResponseException) {
|
||||
deviceDataFailure.increment()
|
||||
throw e
|
||||
} catch (e: WebClientRequestException) {
|
||||
deviceDataFailure.increment()
|
||||
log.error(e) { "Error device registry" }
|
||||
throw ResponseStatusException(SERVICE_UNAVAILABLE)
|
||||
}
|
||||
@@ -53,12 +39,9 @@ class DeviceDataService(
|
||||
request: MeasurementData.Request,
|
||||
): ResponseEntity<Void> = try {
|
||||
webClient.deviceDataAddMeasurement(client, request, deviceDataProperty)
|
||||
.also { deviceDataSuccess.increment() }
|
||||
} catch (e: ErrorResponseException) {
|
||||
deviceDataFailure.increment()
|
||||
throw e
|
||||
} catch (e: WebClientRequestException) {
|
||||
deviceDataFailure.increment()
|
||||
log.error(e) { "Error device registry" }
|
||||
throw ResponseStatusException(SERVICE_UNAVAILABLE)
|
||||
}
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
package ltd.hlaeja.service
|
||||
|
||||
import io.github.oshai.kotlinlogging.KotlinLogging
|
||||
import io.micrometer.core.instrument.Counter
|
||||
import io.micrometer.core.instrument.MeterRegistry
|
||||
import java.util.UUID
|
||||
import ltd.hlaeja.library.deviceRegistry.Identity
|
||||
import ltd.hlaeja.property.DeviceRegistryProperty
|
||||
@@ -19,30 +17,18 @@ private val log = KotlinLogging.logger {}
|
||||
|
||||
@Service
|
||||
class DeviceRegistryService(
|
||||
meterRegistry: MeterRegistry,
|
||||
private val webClient: WebClient,
|
||||
private val deviceRegistryProperty: DeviceRegistryProperty,
|
||||
) {
|
||||
|
||||
private val identityDeviceSuccess = Counter.builder("device.identity.success")
|
||||
.description("Number of successful device identity calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
private val identityDeviceFailure = Counter.builder("device.identity.failure")
|
||||
.description("Number of failed device identity calls")
|
||||
.register(meterRegistry)
|
||||
|
||||
@Cacheable(value = ["identity"], key = "#device")
|
||||
suspend fun getIdentityFromDevice(
|
||||
device: UUID,
|
||||
): Identity.Response = try {
|
||||
webClient.deviceRegistryIdentityDevice(device, deviceRegistryProperty)
|
||||
.also { identityDeviceSuccess.increment() }
|
||||
} catch (e: ErrorResponseException) {
|
||||
identityDeviceFailure.increment()
|
||||
throw e
|
||||
} catch (e: WebClientRequestException) {
|
||||
identityDeviceFailure.increment()
|
||||
log.error(e) { "Error device identity" }
|
||||
throw ResponseStatusException(SERVICE_UNAVAILABLE)
|
||||
}
|
||||
|
||||
@@ -18,22 +18,17 @@ spring:
|
||||
|
||||
management:
|
||||
endpoints:
|
||||
enabled-by-default: false
|
||||
access:
|
||||
default: none
|
||||
web:
|
||||
exposure:
|
||||
include: "health,info"
|
||||
endpoint:
|
||||
health:
|
||||
enabled: true
|
||||
show-details: always
|
||||
access: read_only
|
||||
info:
|
||||
enabled: true
|
||||
influx:
|
||||
metrics:
|
||||
export:
|
||||
api-version: v2
|
||||
bucket: hlaeja
|
||||
org: hlaeja_ltd
|
||||
access: read_only
|
||||
|
||||
cache:
|
||||
time-to-live: 10
|
||||
@@ -53,16 +48,6 @@ spring:
|
||||
redis:
|
||||
host: localhost
|
||||
|
||||
management:
|
||||
metrics:
|
||||
tags:
|
||||
application: device-api
|
||||
influx:
|
||||
metrics:
|
||||
export:
|
||||
enabled: false
|
||||
token: %INFLUXDB_TOKEN%
|
||||
|
||||
server:
|
||||
port: 8443
|
||||
ssl:
|
||||
@@ -92,15 +77,6 @@ spring:
|
||||
redis:
|
||||
host: Redis
|
||||
|
||||
management:
|
||||
metrics:
|
||||
tags:
|
||||
application: device-api
|
||||
influx:
|
||||
metrics:
|
||||
export:
|
||||
uri: http://InfluxDB:8086
|
||||
|
||||
server:
|
||||
port: 8443
|
||||
ssl:
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
<configuration>
|
||||
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||||
<encoder>
|
||||
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
||||
</encoder>
|
||||
</appender>
|
||||
<root level="INFO">
|
||||
<appender-ref ref="STDOUT"/>
|
||||
</root>
|
||||
<logger level="DEBUG" name="ltd.hlaeja"/>
|
||||
</configuration>
|
||||
Reference in New Issue
Block a user