Skip to content

Commit

Permalink
Add Artifacts to steps.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-goral authored and mergify-bot committed Mar 18, 2021
1 parent 61998e5 commit 21ce8df
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion docs/refactor/steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,7 @@ object RemoteStorage {
* `SavedMatrix`
* `TestOutcome`
* `TestSuiteOverviewData`
* `MatrixMap`
* `CancelCommand` -> `cancelLastRun` -> `cancelMatrices` -> `GcTestMatrix/cancel`
* `RefreshCommand` -> `refreshLastRun`
* `refreshMatrices`
Expand All @@ -491,7 +492,13 @@ object RemoteStorage {

```kotlin
object TestMatrix {

data class Result(
val runPath: String,
val map: Map<String, Data>,
)

data class Data(
val matrixId: String = "",
val state: String = "",
val gcsPath: String = "",
Expand Down Expand Up @@ -546,7 +553,7 @@ object TestMatrix {
)

interface Cancel : (Identity) -> Unit
interface Refresh : (Identity) -> Result
interface Refresh : (Identity) -> Data
}
```

Expand Down Expand Up @@ -841,6 +848,7 @@ object JUnitTest {
`ftl/data/PerfMetrics.kt`

```kotlin
package ftl.data

object PerfMetrics {

Expand Down Expand Up @@ -906,4 +914,37 @@ object PerfMetrics {

interface Fetch : (Identity) -> Summary
}
```

### Fetching Artifacts

#### Target

* `FetchArtifacts.kt`

#### Interface

`ftl/data/PerfMetrics.kt`

```kotlin
package ftl.data

object Artifacts {

data class Identity(
val gcsPathWithoutRootBucket: String,
val gcsRootBucket: String,
val regex: List<Regex>,
val blobPath: String,
val downloadPath: DownloadPath,
)

data class DownloadPath(
val localResultDir: String,
val useLocalResultDir: Boolean,
val keepFilePath: Boolean,
)

interface Fetch: (Identity) -> List<String>
}
```

0 comments on commit 21ce8df

Please sign in to comment.