Skip to content

Commit

Permalink
Add system for patching the package manifest (#183)
Browse files Browse the repository at this point in the history 
## Description

Add a system for patching the package manifest used in the
`GenerateUpmPackage` task.

## Changes
* ![ADD] `GenerateUpmPackage` Add a system for patching the package
manifest properties, with a specific one for dependencies

[NEW]:      https://resources.atlas.wooga.com/icons/icon_new.svg "New"
[ADD]:      https://resources.atlas.wooga.com/icons/icon_add.svg "Add"
[IMPROVE]: https://resources.atlas.wooga.com/icons/icon_improve.svg
"Improve"
[CHANGE]: https://resources.atlas.wooga.com/icons/icon_change.svg
"Change"
[FIX]:      https://resources.atlas.wooga.com/icons/icon_fix.svg "Fix"
[UPDATE]: https://resources.atlas.wooga.com/icons/icon_update.svg
"Update"

[BREAK]: https://resources.atlas.wooga.com/icons/icon_break.svg "Remove"
[REMOVE]: https://resources.atlas.wooga.com/icons/icon_remove.svg
"Remove"
[IOS]:      https://resources.atlas.wooga.com/icons/icon_iOS.svg "iOS"
[ANDROID]: https://resources.atlas.wooga.com/icons/icon_android.svg
"Android"
[WEBGL]: https://resources.atlas.wooga.com/icons/icon_webGL.svg "WebGL"
[GRADLE]: https://resources.atlas.wooga.com/icons/icon_gradle.svg
"GRADLE"
[UNITY]: https://resources.atlas.wooga.com/icons/icon_unity.svg "Unity"
[LINUX]: https://resources.atlas.wooga.com/icons/icon_linux.svg "Linux"
[WIN]: https://resources.atlas.wooga.com/icons/icon_windows.svg
"Windows"
[MACOS]:    https://resources.atlas.wooga.com/icons/icon_iOS.svg "macOS"
  • Loading branch information
@Azurelol
Azurelol authored Jul 6, 2023
1 parent 94db98b commit e577017
Show file tree
Hide file tree
Showing 2 changed files with 289 additions and 65 deletions.
173 changes: 147 additions & 26 deletions ...egrationTest/groovy/wooga/gradle/unity/tasks/GenerateUpmPackageTaskIntegrationSpec.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import wooga.gradle.unity.testutils.SetupProjectLayoutTestTask
import wooga.gradle.unity.utils.PackageManifestBuilder
import wooga.gradle.utils.DirectoryComparer

import java.security.Provider

class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {

@Override
Expand All @@ -31,29 +33,29 @@ class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {
runPropertyQuery(getter, setter).matches(value)

where:
propertyName | type | value
"packageDirectory" | "File" | osPath("/path/to/package/dir")
"packageDirectory" | "Provider<Directory>" | osPath("/path/to/package/dir")
"packageName" | "String" | "testPackageA"
"packageName" | "Provider<String>" | "testPackageB"
propertyName | type | value
"packageDirectory" | "File" | osPath("/path/to/package/dir")
"packageDirectory" | "Provider<Directory>" | osPath("/path/to/package/dir")
"packageName" | "String" | "testPackageA"
"packageName" | "Provider<String>" | "testPackageB"

setter = new PropertySetterWriter(subjectUnderTestName, propertyName)
.set(value, type)
.set(value, type)
getter = new PropertyGetterTaskWriter(setter)
}

@Requires({ os.macOs })
@UnityPluginTestOptions(unityPath = UnityPathResolution.Default)
@UnityInstallation(version = "2022.1.15f1", cleanup = false)
def "generates unity package"(
String packageDisplayName,
String unityProjectPath,
String distributionsDirName,
String packageDirectory,
String packageName,
String packageVersion,
String expectedPackageFileName,
Installation unity
String packageDisplayName,
String unityProjectPath,
String distributionsDirName,
String packageDirectory,
String packageName,
String packageVersion,
String expectedPackageFileName,
Installation unity
) {

given: "a pre installed unity editor"
Expand Down Expand Up @@ -115,12 +117,12 @@ class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {

where:
packageDisplayName = "Foobar"
unityProjectPath = "Wooga.${packageDisplayName}"
unityProjectPath = "Wooga.${packageDisplayName}".toString()
distributionsDirName = "build/distributions"
packageDirectory = unityProjectPath + "/Assets/Wooga/Foobar"
packageName = "com.wooga.foobar"
packageVersion = "0.0.1"
expectedPackageFileName = "${packageName}-${packageVersion}.tgz"
expectedPackageFileName = "${packageName}-${packageVersion}.tgz".toString()

and: "the injected unity installation"
unity = null
Expand All @@ -130,14 +132,14 @@ class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {
@UnityPluginTestOptions(unityPath = UnityPathResolution.Default)
@UnityInstallation(version = "2019.4.38f1", cleanup = false)
def "uses package name and version from package.json when not specified"(
String packageDisplayName,
String unityProjectPath,
String distributionsDirName,
String packageDirectory,
String packageName,
String packageVersion,
String expectedPackageFileName,
Installation unity
String packageDisplayName,
String unityProjectPath,
String distributionsDirName,
String packageDirectory,
String packageName,
String packageVersion,
String expectedPackageFileName,
Installation unity
) {

given: "a pre installed unity editor"
Expand Down Expand Up @@ -197,12 +199,12 @@ class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {

where:
packageDisplayName = "Foobar"
unityProjectPath = "Wooga.${packageDisplayName}"
unityProjectPath = "Wooga.${packageDisplayName}".toString()
distributionsDirName = "build/distributions"
packageDirectory = unityProjectPath + "/Assets/Wooga/Foobar"
packageName = "com.wooga.foobar-baz"
packageVersion = "1.1.1"
expectedPackageFileName = "${packageName}-${packageVersion}.tgz"
expectedPackageFileName = "${packageName}-${packageVersion}.tgz".toString()

and: "the injected unity installation"
unity = null
Expand Down Expand Up @@ -255,6 +257,125 @@ class GenerateUpmPackageTaskIntegrationSpec extends UnityIntegrationSpec {
reason = predicate.message
}

@Unroll
def "generate package with patched property #property with value #value"() {

given:
directory(projectPath)
buildFile << """
unity {
projectDirectory.set(${wrapValueBasedOnType(projectPath, Directory)})
}
""".stripIndent()

projectFile(projectPath, "README.MD")
def manifestFile = projectFile(projectPath, GenerateUpmPackage.packageManifestFileName)
manifestFile.write(new PackageManifestBuilder().build())

and:
addTask(taskName, GenerateUpmPackage.class.name, false, """
packageDirectory.set(${wrapValueBasedOnType(projectPath, Directory)})
archiveVersion.set(${wrapValueBasedOnType(packageVersion, String)})
packageName = ${wrapValueBasedOnType(packageName, String)}
dependencies[${wrapValueBasedOnType(dependency1, String)}] = "0.0.0"
patch(${wrapValueBasedOnType(property, String)}, ${wrapValueBasedOnType(value, String)})
""")

when:
def result = runTasks(taskName)

then:
result.success

and:
def manifest = parseManifestFromPackage(packageName, packageVersion)
manifest[property] == value

where:
taskName = "upmPack"
projectPath = "Wooga.Foobar"
packageName = projectPath
packageVersion = "1.2.3"
dependency1 = "com.wooga.pancakes"

property | value
"version" | "4.5.6"
"changelogUrl" | "www.pancakes.com"
}

@Unroll
def "patches version of dependency #dep to #input"() {

given:
directory(projectPath)
buildFile << """
unity {
projectDirectory.set(${wrapValueBasedOnType(projectPath, Directory)})
}
""".stripIndent()

projectFile(projectPath, "README.MD")
def manifestFile = projectFile(projectPath, GenerateUpmPackage.packageManifestFileName)
manifestFile.write(new PackageManifestBuilder().build())

and:
addTask(taskName, GenerateUpmPackage.class.name, false, """
packageDirectory.set(${wrapValueBasedOnType(projectPath, Directory)})
archiveVersion.set(${wrapValueBasedOnType(packageVersion, String)})
packageName = ${wrapValueBasedOnType(packageName, String)}
dependencies[${wrapValueBasedOnType(dependency1, String)}] = "0.0.0"
dependencies[${wrapValueBasedOnType(dependency2, String)}] = "0.0.0"
patchDependency(${wrapValueBasedOnType(dep, String)}, ${wrapValueBasedOnType(input, type)})
""")

when:
def result = runTasks(taskName)

then:
result.success

and:
def manifest = parseManifestFromPackage(packageName, packageVersion)
if (expected == _) {
expected = input
}
manifest["dependencies"][dep] == expected

where:
dep | input | type | expected
"com.wooga.foo" | "2.4.6" | String | _
"com.wooga.bar" | "5.2.3" | String | _
"com.wooga.foo" | "1.1.1" | "Provider<String>" | "1.1.1"

taskName = "upmPack"
projectPath = "Wooga.Foobar"
packageName = projectPath
packageVersion = "1.2.3"

dependency1 = "com.wooga.foo"
dependency2 = "com.wooga.bar"
}

private File getPackageFile(String name, String version) {
def distributionsDirName = "build/distributions"
def expectedPackageFileName = "${name}-${version}.tgz"
def distributionsDir = new File(projectDir, distributionsDirName)
def packageFile = new File(distributionsDir, expectedPackageFileName)
}

private Object parseManifestFromPackage(String name, String version) {
def packageFile = getPackageFile(name, version)
def packageManifestUnpackDir = unpackPackage(packageFile)
def unpackedPackageDir = new File(packageManifestUnpackDir, "package")
def packageManifestFile = new File(unpackedPackageDir, GenerateUpmPackage.packageManifestFileName)
def json = new JsonSlurper().parse(packageManifestFile)
json
}

private static File unpackPackage(File packageFile) {
def packageManifestUnpackDir = File.createTempDir(packageFile.name, "_unpack")
def ant = new AntBuilder()
Expand Down
Loading

0 comments on commit e577017

Please sign in to comment.