Skip to content

Commit 7fd92f2

Browse files
committed
refactor: rename platform related audit fields
1 parent 033e95e commit 7fd92f2

8 files changed

Lines changed: 38 additions & 38 deletions

File tree

src/main/kotlin/io/sdkman/broker/adapter/secondary/persistence/PostgresAuditRepository.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ object AuditTable : Table("audit") {
1919
val command: Column<String> = text("command")
2020
val candidate: Column<String> = text("candidate")
2121
val version: Column<String> = text("version")
22-
val platform: Column<String> = text("platform")
22+
val clientPlatform: Column<String> = text("client_platform")
23+
val candidatePlatform: Column<String> = text("candidate_platform")
2324
val distribution: Column<String?> = text("distribution").nullable()
2425
val host: Column<String?> = text("host").nullable()
2526
val agent: Column<String?> = text("agent").nullable()
26-
val dist: Column<String> = text("dist")
2727
val timestamp = timestamp("timestamp")
2828

2929
override val primaryKey = PrimaryKey(id)
@@ -41,11 +41,11 @@ class PostgresAuditRepository(private val dataSource: DataSource) : AuditReposit
4141
it[command] = audit.command
4242
it[candidate] = audit.candidate
4343
it[version] = audit.version
44-
it[platform] = audit.platform
44+
it[clientPlatform] = audit.clientPlatform
45+
it[candidatePlatform] = audit.candidatePlatform
4546
it[distribution] = audit.distribution.getOrNull()
4647
it[host] = audit.host.getOrNull()
4748
it[agent] = audit.agent.getOrNull()
48-
it[dist] = audit.dist
4949
it[timestamp] = audit.timestamp
5050
}
5151
Unit

src/main/kotlin/io/sdkman/broker/application/service/AuditCommand.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ data class AuditCommand(
2323
versionEntity.distribution
2424
.map { vendor -> versionEntity.version.removeSuffix("-$vendor") }
2525
.getOrElse { versionEntity.version },
26-
platform = clientPlatform.auditId,
27-
dist = versionEntity.resolveTargetPlatform(clientPlatform).auditId,
26+
clientPlatform = clientPlatform.auditId,
27+
candidatePlatform = versionEntity.resolveCandidatePlatformFor(clientPlatform).auditId,
2828
distribution = versionEntity.distribution,
2929
host = auditContext.host,
3030
agent = auditContext.agent,
3131
timestamp = Clock.System.now()
3232
)
3333

34-
private fun Version.resolveTargetPlatform(sourcePlatform: Platform): Platform =
34+
private fun Version.resolveCandidatePlatformFor(clientPlatform: Platform): Platform =
3535
when (this.platform) {
3636
Platform.Universal.persistentId -> Platform.Universal
37-
else -> sourcePlatform
37+
else -> clientPlatform
3838
}
3939
}

src/main/kotlin/io/sdkman/broker/domain/model/Audit.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ data class Audit(
99
val command: String,
1010
val candidate: String,
1111
val version: String,
12-
val platform: String,
13-
val dist: String,
12+
val clientPlatform: String,
13+
val candidatePlatform: String,
1414
val distribution: Option<String>,
1515
val host: Option<String>,
1616
val agent: Option<String>,

src/test/kotlin/io/sdkman/broker/acceptance/VersionDownloadAuditAcceptanceSpec.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ class VersionDownloadAuditAcceptanceSpec : ShouldSpec({
7373
record[AuditTable.command] shouldBe "install"
7474
record[AuditTable.candidate] shouldBe "java"
7575
record[AuditTable.version] shouldBe "17.0.2"
76-
record[AuditTable.platform] shouldBe "MAC_ARM64"
77-
record[AuditTable.dist] shouldBe "MAC_ARM64"
76+
record[AuditTable.clientPlatform] shouldBe "MAC_ARM64"
77+
record[AuditTable.candidatePlatform] shouldBe "MAC_ARM64"
7878
record[AuditTable.distribution] shouldBe "tem"
7979
record[AuditTable.host] shouldBe "203.0.113.195"
8080
record[AuditTable.agent] shouldBe "curl/7.68.0"
@@ -130,8 +130,8 @@ class VersionDownloadAuditAcceptanceSpec : ShouldSpec({
130130
record[AuditTable.command] shouldBe "install"
131131
record[AuditTable.candidate] shouldBe "groovy"
132132
record[AuditTable.version] shouldBe "4.0.0"
133-
record[AuditTable.platform] shouldBe "LINUX_X64"
134-
record[AuditTable.dist] shouldBe "UNIVERSAL"
133+
record[AuditTable.clientPlatform] shouldBe "LINUX_X64"
134+
record[AuditTable.candidatePlatform] shouldBe "UNIVERSAL"
135135
record[AuditTable.distribution] shouldBe null
136136
record[AuditTable.host] shouldBe "192.168.1.100"
137137
record[AuditTable.agent] shouldBe "SDKMAN/5.19.0"

src/test/kotlin/io/sdkman/broker/adapter/secondary/persistence/PostgresAuditRepositoryIntegrationSpec.kt

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
3535
command = "install",
3636
candidate = "java",
3737
version = "17.0.2-open",
38-
platform = "linuxx64",
38+
clientPlatform = "LINUX_X64",
39+
candidatePlatform = "LINUX_X64",
3940
distribution = Some("openjdk"),
4041
host = Some("test-host"),
4142
agent = Some("test-agent"),
42-
dist = "LINUX_X64",
4343
timestamp = Clock.System.now()
4444
)
4545

@@ -54,11 +54,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
5454
record[AuditTable.command] shouldBe audit.command
5555
record[AuditTable.candidate] shouldBe audit.candidate
5656
record[AuditTable.version] shouldBe audit.version
57-
record[AuditTable.platform] shouldBe audit.platform
57+
record[AuditTable.clientPlatform] shouldBe audit.clientPlatform
58+
record[AuditTable.candidatePlatform] shouldBe audit.candidatePlatform
5859
record[AuditTable.distribution] shouldBe audit.distribution.getOrNull()
5960
record[AuditTable.host] shouldBe audit.host.getOrNull()
6061
record[AuditTable.agent] shouldBe audit.agent.getOrNull()
61-
record[AuditTable.dist] shouldBe audit.dist
6262
}
6363
}
6464

@@ -70,11 +70,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
7070
command = "install",
7171
candidate = "java",
7272
version = "17.0.2-open",
73-
platform = "linux64",
73+
clientPlatform = "LINUX_X64",
74+
candidatePlatform = "LINUX_X64",
7475
distribution = None,
7576
host = Some("test-host"),
7677
agent = Some("test-agent"),
77-
dist = "test-dist",
7878
timestamp = Clock.System.now()
7979
)
8080

@@ -98,11 +98,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
9898
command = "install",
9999
candidate = "java",
100100
version = "17.0.2-open",
101-
platform = "linux64",
101+
clientPlatform = "LINUX_X64",
102+
candidatePlatform = "LINUX_X64",
102103
distribution = Some("openjdk"),
103104
host = None,
104105
agent = Some("test-agent"),
105-
dist = "test-dist",
106106
timestamp = Clock.System.now()
107107
)
108108

@@ -125,11 +125,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
125125
command = "install",
126126
candidate = "java",
127127
version = "17.0.2-open",
128-
platform = "linux64",
128+
clientPlatform = "LINUX_X64",
129+
candidatePlatform = "LINUX_X64",
129130
distribution = Some("openjdk"),
130131
host = Some("test-host"),
131132
agent = None,
132-
dist = "test-dist",
133133
timestamp = Clock.System.now()
134134
)
135135

@@ -151,11 +151,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
151151
command = "list",
152152
candidate = "kotlin",
153153
version = "1.9.22",
154-
platform = "linux64",
154+
clientPlatform = "LINUX_X64",
155+
candidatePlatform = "LINUX_X64",
155156
distribution = Some("jetbrains"),
156157
host = Some("test-host"),
157158
agent = Some("test-agent"),
158-
dist = "test-dist",
159159
timestamp = Clock.System.now()
160160
)
161161

@@ -168,7 +168,7 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
168168
database = database,
169169
candidate = audit.candidate,
170170
version = audit.version,
171-
platform = audit.platform
171+
platform = audit.clientPlatform
172172
)
173173

174174
savedRecord shouldBeSomeAnd { record ->
@@ -191,11 +191,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
191191
command = "install",
192192
candidate = "java",
193193
version = "17.0.2-open",
194-
platform = "linux64",
194+
clientPlatform = "LINUX_X64",
195+
candidatePlatform = "LINUX_X64",
195196
distribution = None,
196197
host = Some("test-host"),
197198
agent = Some("test-agent"),
198-
dist = "test-dist",
199199
timestamp = Clock.System.now()
200200
)
201201

@@ -218,11 +218,11 @@ class PostgresAuditRepositoryIntegrationSpec : ShouldSpec({
218218
command = "install",
219219
candidate = "java",
220220
version = "17.0.2-open",
221-
platform = "linux64",
221+
clientPlatform = "LINUX_X64",
222+
candidatePlatform = "LINUX_X64",
222223
distribution = None,
223224
host = Some("test-host"),
224225
agent = Some("test-agent"),
225-
dist = "test-dist",
226226
timestamp = Clock.System.now()
227227
)
228228

src/test/kotlin/io/sdkman/broker/application/service/CandidateDownloadServiceSpec.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ class CandidateDownloadServiceSpec : ShouldSpec({
7676
command shouldBe "install"
7777
version shouldBe "17.0.2"
7878
candidate shouldBe "java"
79-
platform shouldBe "MAC_ARM64"
80-
dist shouldBe "MAC_ARM64"
79+
clientPlatform shouldBe "MAC_ARM64"
80+
candidatePlatform shouldBe "MAC_ARM64"
8181
distribution shouldBe "tem".some()
8282
host shouldBe testAuditContext.host
8383
agent shouldBe testAuditContext.agent
@@ -120,8 +120,8 @@ class CandidateDownloadServiceSpec : ShouldSpec({
120120
command shouldBe "install"
121121
candidate shouldBe "groovy"
122122
version shouldBe "4.0.0"
123-
platform shouldBe "LINUX_X64"
124-
dist shouldBe "UNIVERSAL"
123+
clientPlatform shouldBe "LINUX_X64"
124+
candidatePlatform shouldBe "UNIVERSAL"
125125
distribution shouldBe none()
126126
host shouldBe testAuditContext.host
127127
agent shouldBe testAuditContext.agent

src/test/kotlin/io/sdkman/broker/support/PostgresTestSupport.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ object PostgresTestSupport {
3232
val baseCondition =
3333
(AuditTable.candidate eq candidate) and
3434
(AuditTable.version eq version) and
35-
(AuditTable.platform eq platform)
35+
(AuditTable.clientPlatform eq platform)
3636

3737
vendor.fold(
3838
ifEmpty = { baseCondition },

src/test/resources/db/migration/V1__create_audit_table.sql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ CREATE TABLE audit (
55
command TEXT NOT NULL,
66
candidate TEXT NOT NULL,
77
version TEXT NOT NULL,
8-
platform TEXT NOT NULL,
9-
dist TEXT NOT NULL,
8+
client_platform TEXT NOT NULL,
9+
candidate_platform TEXT NOT NULL,
1010
distribution TEXT NULL,
1111
host TEXT NULL,
1212
agent TEXT NULL,

0 commit comments

Comments
 (0)