Skip to content

Commit cd64a8e

Browse files
VampireVampire
committed
feat(abg): add binding version v2
1 parent 7f029fa commit cd64a8e

42 files changed

Lines changed: 2717 additions & 631 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/bindings-server.main.kts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,16 @@ workflow(
103103

104104
cleanMavenLocal()
105105

106+
run(
107+
name = "Execute the script using the bindings from the server with v2 route",
108+
command = """
109+
mv .github/workflows/test-script-consuming-jit-bindings-v2.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-v2.main.kts
110+
.github/workflows/test-script-consuming-jit-bindings-v2.main.kts
111+
""".trimIndent(),
112+
)
113+
114+
cleanMavenLocal()
115+
106116
run(
107117
name = "Execute the script using bindings but without dependency on library",
108118
command = """

‎.github/workflows/bindings-server.yaml‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,46 +65,54 @@ jobs:
6565
name: 'Clean Maven Local to fetch required POMs again'
6666
run: 'rm -rf ~/.m2/repository/'
6767
- id: 'step-9'
68+
name: 'Execute the script using the bindings from the server with v2 route'
69+
run: |-
70+
mv .github/workflows/test-script-consuming-jit-bindings-v2.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-v2.main.kts
71+
.github/workflows/test-script-consuming-jit-bindings-v2.main.kts
72+
- id: 'step-10'
73+
name: 'Clean Maven Local to fetch required POMs again'
74+
run: 'rm -rf ~/.m2/repository/'
75+
- id: 'step-11'
6876
name: 'Execute the script using bindings but without dependency on library'
6977
run: |-
7078
mv .github/workflows/test-served-bindings-depend-on-library.main.do-not-compile.kts .github/workflows/test-served-bindings-depend-on-library.main.kts
7179
.github/workflows/test-served-bindings-depend-on-library.main.kts
72-
- id: 'step-10'
80+
- id: 'step-12'
7381
name: 'Install Kotlin 1.9.0'
7482
uses: 'fwilhe2/setup-kotlin@0.11.0'
7583
with:
7684
version: '1.9.0'
77-
- id: 'step-11'
85+
- id: 'step-13'
7886
name: 'Clean Maven Local to fetch required POMs again'
7987
run: 'rm -rf ~/.m2/repository/'
80-
- id: 'step-12'
88+
- id: 'step-14'
8189
name: 'Execute the script using the bindings from the server, using older Kotlin (1.9.0) as consumer'
8290
run: |2-
8391
cp .github/workflows/test-script-consuming-jit-bindings.main.kts .github/workflows/test-script-consuming-jit-bindings-too-old-kotlin.main.kts
8492
(.github/workflows/test-script-consuming-jit-bindings-too-old-kotlin.main.kts || true) >> output.txt 2>&1
8593
grep "was compiled with an incompatible version of Kotlin" output.txt
86-
- id: 'step-13'
94+
- id: 'step-15'
8795
name: 'Install Kotlin 2.0.0'
8896
uses: 'fwilhe2/setup-kotlin@0.11.0'
8997
with:
9098
version: '2.0.0'
91-
- id: 'step-14'
99+
- id: 'step-16'
92100
name: 'Clean Maven Local to fetch required POMs again'
93101
run: 'rm -rf ~/.m2/repository/'
94-
- id: 'step-15'
102+
- id: 'step-17'
95103
name: 'Execute the script using the bindings from the server, using older Kotlin (2.0.0) as consumer'
96104
run: |-
97105
cp .github/workflows/test-script-consuming-jit-bindings.main.kts .github/workflows/test-script-consuming-jit-bindings-older-kotlin.main.kts
98106
.github/workflows/test-script-consuming-jit-bindings-older-kotlin.main.kts
99-
- id: 'step-16'
107+
- id: 'step-18'
100108
name: 'Compile a Gradle project using the bindings from the server'
101109
run: |-
102110
cd .github/workflows/test-gradle-project-using-bindings-server
103111
./gradlew build
104-
- id: 'step-17'
112+
- id: 'step-19'
105113
name: 'Fetch maven-metadata.xml for top-level action'
106114
run: 'curl --fail http://localhost:8080/actions/checkout/maven-metadata.xml | grep ''<version>v4</version>'''
107-
- id: 'step-18'
115+
- id: 'step-20'
108116
name: 'Fetch maven-metadata.xml for nested action'
109117
run: 'curl --fail http://localhost:8080/actions/cache__save/maven-metadata.xml | grep ''<version>v4</version>'''
110118
deploy:

‎.github/workflows/test-script-consuming-jit-bindings-v1.main.do-not-compile.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env kotlin
22
@file:Repository("https://repo.maven.apache.org/maven2/")
3-
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:1.13.0")
3+
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:3.0.0")
44

55
@file:Repository("http://localhost:8080/v1")
66

‎.github/workflows/test-script-consuming-jit-bindings-v2.main.do-not-compile.kts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env kotlin
2+
@file:Repository("https://repo.maven.apache.org/maven2/")
3+
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:3.0.0")
4+
5+
@file:Repository("http://localhost:8080/v2")
6+
7+
// Regular, top-level action.
8+
@file:DependsOn("actions:checkout:v4")
9+
10+
// Nested action.
11+
@file:DependsOn("gradle:actions__setup-gradle:v3")
12+
13+
// Using specific version.
14+
@file:DependsOn("actions:cache:v3.3.3")
15+
16+
// Always untyped action.
17+
@file:DependsOn("typesafegithub:always-untyped-action-for-tests:v1")
18+
19+
import io.github.typesafegithub.workflows.actions.actions.Cache
20+
import io.github.typesafegithub.workflows.actions.actions.Checkout
21+
import io.github.typesafegithub.workflows.actions.actions.Checkout_Untyped
22+
import io.github.typesafegithub.workflows.actions.gradle.ActionsSetupGradle
23+
import io.github.typesafegithub.workflows.actions.typesafegithub.AlwaysUntypedActionForTests_Untyped
24+
25+
println(Checkout_Untyped(fetchTags_Untyped = "false"))
26+
println(Checkout(fetchTags = false))
27+
println(Checkout(fetchTags_Untyped = "false"))
28+
println(AlwaysUntypedActionForTests_Untyped(foobar_Untyped = "baz"))
29+
println(ActionsSetupGradle())
30+
println(Cache(path = listOf("some-path"), key = "some-key"))
31+
32+
// Ensure that 'copy(...)' method is exposed.
33+
Checkout(fetchTags = false).copy(fetchTags = true)

‎.github/workflows/test-script-consuming-jit-bindings.main.do-not-compile.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env kotlin
22
@file:Repository("https://repo.maven.apache.org/maven2/")
3-
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:1.13.0")
3+
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:3.0.0")
44

55
@file:Repository("http://localhost:8080")
66

‎action-binding-generator/api/action-binding-generator.api‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ public abstract interface class io/github/typesafegithub/workflows/actionbinding
184184

185185
public final class io/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion : java/lang/Enum {
186186
public static final field V1 Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;
187+
public static final field V2 Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;
187188
public static fun getEntries ()Lkotlin/enums/EnumEntries;
188189
public final fun getLibraryVersion ()Ljava/lang/String;
189190
public final fun isDeprecated ()Z

‎action-binding-generator/build.gradle.kts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ dependencies {
1717
implementation("io.github.oshai:kotlin-logging:7.0.3")
1818
implementation(projects.sharedInternal)
1919

20+
testImplementation("io.kotest:kotest-framework-datatest")
21+
testImplementation(kotlin("reflect"))
2022
testImplementation(projects.githubWorkflowsKt)
2123
}
2224

‎action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ public enum class BindingVersion(
66
public val libraryVersion: String,
77
) {
88
V1(isExperimental = false, libraryVersion = "3.0.2"),
9+
V2(libraryVersion = "3.0.2"),
910
;
1011

1112
override fun toString(): String = super.toString().lowercase()

‎action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/Utils.kt‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
package io.github.typesafegithub.workflows.actionbindinggenerator
22

33
import io.github.typesafegithub.workflows.actionbindinggenerator.generation.ActionBinding
4+
import io.github.typesafegithub.workflows.actionbindinggenerator.versioning.BindingVersion
5+
import io.github.typesafegithub.workflows.domain.actions.Action
6+
import io.kotest.common.mapError
7+
import io.kotest.core.spec.style.scopes.ContainerScope
8+
import io.kotest.datatest.withData
49
import io.kotest.matchers.Matcher.Companion.failure
510
import io.kotest.matchers.shouldBe
11+
import java.lang.reflect.InvocationTargetException
612
import java.nio.file.Paths
713

814
fun List<ActionBinding>.shouldContainAndMatchFile(path: String) {
@@ -36,3 +42,68 @@ fun List<ActionBinding>.shouldContainAndMatchFile(path: String) {
3642
}
3743

3844
private fun String.removeWindowsNewLines(): String = replace("\r\n", "\n")
45+
46+
fun constructAction(
47+
owner: String,
48+
classBaseName: String,
49+
bindingVersion: BindingVersion,
50+
arguments: Map<String, Any?> = emptyMap(),
51+
): Action<*> {
52+
val constructor =
53+
Class
54+
.forName("io.github.typesafegithub.workflows.actions.$owner.${classBaseName}Binding${bindingVersion.name}")
55+
.let {
56+
@Suppress("UNCHECKED_CAST")
57+
it as Class<Action<*>>
58+
}.kotlin
59+
.constructors
60+
.first()
61+
return runCatching {
62+
constructor.callBy(
63+
arguments.mapKeys { (key, _) ->
64+
constructor.parameters.first { it.name == key }
65+
},
66+
)
67+
}.mapError {
68+
if (it is InvocationTargetException) it.targetException else it
69+
}.getOrThrow()
70+
}
71+
72+
suspend fun ContainerScope.withBindingVersions(
73+
bindingVersions: Iterable<BindingVersion>,
74+
test: suspend ContainerScope.(BindingVersion) -> Unit,
75+
) = withData(
76+
nameFn = { "binding version $it" },
77+
ts = bindingVersions,
78+
test = test,
79+
)
80+
81+
suspend fun ContainerScope.withAllBindingVersions(test: suspend ContainerScope.(BindingVersion) -> Unit) =
82+
withBindingVersions(
83+
bindingVersions = BindingVersion.entries,
84+
test = test,
85+
)
86+
87+
suspend fun ContainerScope.withBindingVersions(
88+
bindingVersions: OpenEndRange<BindingVersion>,
89+
test: suspend ContainerScope.(BindingVersion) -> Unit,
90+
) = withBindingVersions(
91+
bindingVersions = BindingVersion.entries.filter { it in bindingVersions },
92+
test = test,
93+
)
94+
95+
suspend fun ContainerScope.withBindingVersions(
96+
bindingVersions: ClosedRange<BindingVersion>,
97+
test: suspend ContainerScope.(BindingVersion) -> Unit,
98+
) = withBindingVersions(
99+
bindingVersions = BindingVersion.entries.filter { it in bindingVersions },
100+
test = test,
101+
)
102+
103+
suspend fun ContainerScope.withBindingVersionsFrom(
104+
bindingVersion: BindingVersion,
105+
test: suspend ContainerScope.(BindingVersion) -> Unit,
106+
) = withBindingVersions(
107+
bindingVersions = bindingVersion..BindingVersion.entries.last(),
108+
test = test,
109+
)

action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithSubAction.kt renamed to action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionBindingV1WithSubAction.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ import kotlin.collections.Map
2222
*
2323
* Description
2424
*
25-
* [Action on GitHub](https://github.com/john-smith/action-with/tree/v3/sub/action)
25+
* [Action on GitHub](https://github.com/john-smith/action-binding-v1-with/tree/v3/sub/action)
2626
*
2727
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by the binding
2828
* @param _customVersion Allows overriding action's version, for example to use a specific minor version, or a newer version that the binding doesn't yet know about
2929
*/
3030
@ExposedCopyVisibility
31-
public data class ActionWithSubAction private constructor(
31+
public data class ActionBindingV1WithSubAction private constructor(
3232
/**
3333
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
3434
*/
@@ -37,7 +37,7 @@ public data class ActionWithSubAction private constructor(
3737
* Allows overriding action's version, for example to use a specific minor version, or a newer version that the binding doesn't yet know about
3838
*/
3939
public val _customVersion: String? = null,
40-
) : RegularAction<Action.Outputs>("john-smith", "action-with/sub/action", _customVersion ?: "v3") {
40+
) : RegularAction<Action.Outputs>("john-smith", "action-binding-v1-with/sub/action", _customVersion ?: "v3") {
4141
public constructor(
4242
vararg pleaseUseNamedArguments: Unit,
4343
_customInputs: Map<String, String> = mapOf(),

0 commit comments

Comments
 (0)