Merge pull request OSGP#49 from OSGP/feature/FDP-2551-firmware

FDP-2551: Firmware entities

application/build.gradle.kts

@@ -17,6 +17,7 @@ dependencies {
     implementation("org.springframework.kafka:spring-kafka")
 
     implementation(project(":components:psk"))
+    implementation(project(":components:firmware"))
 
     implementation(kotlin("reflect"))
     implementation(libs.logging)
@@ -65,6 +66,7 @@ testing {
             dependencies {
                 implementation(project())
                 implementation(project(":components:psk"))
+                implementation(project(":components:firmware"))
                 implementation("org.springframework.boot:spring-boot-starter-data-jpa")
                 implementation(libs.kafkaAvro)
                 implementation(libs.avro)

application/src/main/resources/db/migration/V8__firmware.sql

@@ -0,0 +1,22 @@
+CREATE TABLE firmware
+(
+    id                   uuid         not null,
+    name                 varchar(255) not null,
+    hash                 varchar(255) not null,
+    previous_firmware_id uuid          null,
+    PRIMARY KEY (id),
+    CONSTRAINT fk_previous_firmware
+        FOREIGN KEY (previous_firmware_id)
+            REFERENCES firmware (id)
+);
+
+CREATE TABLE firmware_packet
+(
+    firmware_id   uuid not null,
+    packet_number int  not null,
+    packet        varchar(1024),
+    PRIMARY KEY (firmware_id, packet_number),
+    CONSTRAINT fk_firmware
+        FOREIGN KEY (firmware_id)
+            REFERENCES firmware (id)
+)

components/firmware/build.gradle.kts

@@ -0,0 +1,11 @@
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    implementation("org.springframework.security:spring-security-core")
+
+    implementation(libs.logging)
+
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation(libs.mockitoKotlin)
+
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/entity/Firmware.kt

@@ -0,0 +1,21 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.entity
+
+import jakarta.annotation.Generated
+import jakarta.persistence.Entity
+import jakarta.persistence.Id
+import jakarta.persistence.OneToMany
+import java.util.UUID
+import org.hibernate.annotations.Cascade
+import org.hibernate.annotations.CascadeType
+
+@Entity
+class Firmware(
+    @Id @Generated val id: UUID,
+    val name: String,
+    val hash: String,
+    val previousFirmwareId: UUID?,
+    @OneToMany @Cascade(CascadeType.ALL) val packets: List<FirmwarePacket>
+)

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/entity/FirmwarePacket.kt

@@ -0,0 +1,17 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.entity
+
+import jakarta.persistence.Entity
+import jakarta.persistence.Id
+import jakarta.persistence.IdClass
+import jakarta.persistence.ManyToOne
+
+@Entity
+@IdClass(FirmwarePacketCompositeKey::class)
+class FirmwarePacket(
+    @ManyToOne @Id val firmware: Firmware,
+    @Id val packetNumber: Int,
+    val packet: String
+)

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/entity/FirmwarePacketCompositeKey.kt

@@ -0,0 +1,8 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.entity
+
+import java.io.Serializable
+
+data class FirmwarePacketCompositeKey(val firmware: Firmware, val packetNumber: Int) : Serializable

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/repository/FirmwarePacketRepository.kt

@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.repository
+
+import org.gxf.crestdeviceservice.firmware.entity.FirmwarePacket
+import org.gxf.crestdeviceservice.firmware.entity.FirmwarePacketCompositeKey
+import org.springframework.data.repository.CrudRepository
+import org.springframework.stereotype.Repository
+
+@Repository
+interface FirmwarePacketRepository : CrudRepository<FirmwarePacket, FirmwarePacketCompositeKey>

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/repository/FirmwareRepository.kt

@@ -0,0 +1,13 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.repository
+
+import org.gxf.crestdeviceservice.firmware.entity.Firmware
+import org.springframework.data.repository.CrudRepository
+import org.springframework.stereotype.Repository
+
+@Repository
+interface FirmwareRepository : CrudRepository<Firmware, Int> {
+    fun findByName(name: String): Firmware
+}

components/firmware/src/main/kotlin/org/gxf/crestdeviceservice/firmware/service/FirmwareService.kt

@@ -0,0 +1,9 @@
+// SPDX-FileCopyrightText: Contributors to the GXF project
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.gxf.crestdeviceservice.firmware.service
+
+import org.gxf.crestdeviceservice.firmware.repository.FirmwareRepository
+import org.springframework.stereotype.Service
+
+@Service class FirmwareService(private val firmwareRepository: FirmwareRepository)

components/psk/src/main/kotlin/org/gxf/crestdeviceservice/psk/entity/PreSharedKeyCompositeKey.kt

@@ -5,6 +5,6 @@ package org.gxf.crestdeviceservice.psk.entity
 
 import java.io.Serializable
 
-class PreSharedKeyCompositeKey(val identity: String?, val revision: Int?) : Serializable {
+data class PreSharedKeyCompositeKey(val identity: String?, val revision: Int?) : Serializable {
     constructor() : this(null, null)
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

scripts/pre-commit

@@ -3,6 +3,8 @@ echo "*********************************************************"
 echo "Running git pre-commit hook. Running Spotless Apply... "
 echo "*********************************************************"
 
+[[ -s "$HOME/.sdkman/bin/sdkman-init.sh" ]] && source "$HOME/.sdkman/bin/sdkman-init.sh"
+
 # Gather the staged files - to make sure changes are saved only for these files.
 stagedFiles=$(git diff --staged --name-only)
 

settings.gradle.kts

@@ -6,6 +6,7 @@ rootProject.name = "sng-crest-device-service"
 
 include("application")
 include("components:psk")
+include("components:firmware")
 
 dependencyResolutionManagement {
     versionCatalogs {