Download and generate Spdx licenses #316

hfhbd · 2024-03-29T23:54:13Z

No description provided.

JakeWharton

Have not reviewed the whole thing

JakeWharton · 2024-03-30T01:34:15Z

gradle/build-logic/src/main/kotlin/app/cash/licensee/GenerateSpdxIdTask.kt

+  abstract val generatedSpdx: DirectoryProperty
+
+  init {
+    inputJson.convention(project.resources.text.fromUri("https://spdx.org/licenses/licenses.json").asString())


Whaaaaaaat is going on here. Gradle has an entire HTTP client hidden in a property factory?

I think I actually want to revert to continuing the embed the JSON, except we can embed it into the build-logic for this task to use. I'm generally wary of depending on the internet and would prefer updates be explicit rather than it magically getting new values based on whenever you build.

Whaaaaaaat is going on here. Gradle has an entire HTTP client hidden in a property factory?

Yup, since 2.2.

I think I actually want to revert to continuing the embed the JSON

So we download the json (manually/ automatically) using Gradle but keep the generator to generate Kotlin code from the Json to have typed Spdx Ids? Sounds okay for me too.

Yeah, and it can't fail a release due connections problems/new entries.

Right. And that's basically the goal. We don't want it to change out from underneath us. Also means old builds are reproducible, although not sure why that would ever be needed.

gradle/build-logic/src/main/kotlin/app/cash/licensee/GenerateSpdxIdTask.kt

gradle/build-logic/src/main/kotlin/app.cash.licensee.repos.settings.gradle.kts

gradle/build-logic/src/main/kotlin/app/cash/licensee/defaultFallbackUrls.kt

src/test/kotlin/app/cash/licensee/SpdxLicensesTest.kt

JakeWharton · 2024-03-30T19:32:54Z

Is sorting needed? I filed a bug upstream a few years ago for them to do stable sorting. The last JSON update for 0.11 seemed to indicate they now sort.

hfhbd · 2024-03-31T12:41:59Z

I don't know because I can only get the latest json but let's remove it and see it next update, and add it if needed.

Goooler · 2024-04-02T02:14:36Z

gradle/build-logic/src/main/kotlin/app/cash/licensee/defaultFallbackUrls.kt

@@ -15,7 +15,7 @@
 */
 package app.cash.licensee

-internal val fallbackUrls = buildMap {
+internal val defaultFallbackUrls: FallbackBuilder.() -> Unit = {


Suggested change

internal val defaultFallbackUrls: FallbackBuilder.() -> Unit = {

@Suppress("HttpUrlsUsage")

internal val defaultFallbackUrls: FallbackBuilder.() -> Unit = {

Goooler · 2024-04-02T02:17:19Z

gradle/build-logic/src/main/kotlin/app/cash/licensee/GenerateSpdxIdTask.kt

+  val fileSpec = FileSpec.builder("app.cash.licensee", "licensesSpdx")
+
+  fileSpec.addType(addSpdxIdInterface())
+
+  return fileSpec.build()


Suggested change

val fileSpec = FileSpec.builder("app.cash.licensee", "licensesSpdx")

fileSpec.addType(addSpdxIdInterface())

return fileSpec.build()

return FileSpec.builder("app.cash.licensee", "licensesSpdx")

.addType(addSpdxIdInterface())

.build()

Goooler · 2024-04-02T02:24:46Z

gradle/build-logic/src/main/kotlin/app/cash/licensee/SpdxLicenses.kt

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package app.cash.licensee


Suggested change

package app.cash.licensee

@file:Suppress("HttpUrlsUsage")

package app.cash.licensee

Goooler · 2024-04-02T02:28:19Z

build.gradle

+RegularFile jsonFile = layout.projectDirectory.file("src/main/resources/app/cash/licensee/licenses.json")
+
+tasks.register("downloadLicensesJson", app.cash.licensee.SortedSpdx) {
+  json.set(resources.text.fromUri("https://spdx.org/licenses/licenses.json").asString())
+  sortedLicencesJson.set(jsonFile)


Suggested change

RegularFile jsonFile = layout.projectDirectory.file("src/main/resources/app/cash/licensee/licenses.json")

tasks.register("downloadLicensesJson", app.cash.licensee.SortedSpdx) {

json.set(resources.text.fromUri("https://spdx.org/licenses/licenses.json").asString())

sortedLicencesJson.set(jsonFile)

def jsonFile = layout.projectDirectory.file("src/main/resources/app/cash/licensee/licenses.json")

tasks.register("downloadLicensesJson", app.cash.licensee.SortedSpdx) {

json = resources.text.fromUri("https://spdx.org/licenses/licenses.json").asString()

sortedLicencesJson = jsonFile

}

Goooler · 2024-04-02T02:28:49Z

build.gradle

+TaskProvider<app.cash.licensee.GenerateSpdxIdTask> generateSpdx = tasks.register('generateSpdx', app.cash.licensee.GenerateSpdxIdTask) {
+  // Do not wire the output from writeSortedSpdx here to split downloading the remote file and code gen.
+  inputJson.set(jsonFile)
+}


Suggested change

TaskProvider<app.cash.licensee.GenerateSpdxIdTask> generateSpdx = tasks.register('generateSpdx', app.cash.licensee.GenerateSpdxIdTask) {

// Do not wire the output from writeSortedSpdx here to split downloading the remote file and code gen.

inputJson.set(jsonFile)

}

def generateSpdx = tasks.register('generateSpdx', app.cash.licensee.GenerateSpdxIdTask) {

// Do not wire the output from writeSortedSpdx here to split downloading the remote file and code gen.

inputJson = jsonFile

}

Goooler · 2024-04-02T02:29:36Z

gradle/build-logic/settings.gradle

+import org.gradle.api.initialization.resolve.RepositoriesMode
+
+dependencyResolutionManagement {
+  repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)


Suggested change

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

repositoriesMode = RepositoriesMode.FAIL_ON_PROJECT_REPOS

Goooler · 2024-04-02T02:29:52Z

gradle/build-logic/src/main/kotlin/app.cash.licensee.repos.settings.gradle.kts

+import org.gradle.api.initialization.resolve.RepositoriesMode
+
+dependencyResolutionManagement {
+  repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)


Suggested change

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

repositoriesMode = RepositoriesMode.FAIL_ON_PROJECT_REPOS

Goooler · 2024-04-02T02:31:52Z

gradle/build-logic/src/test/kotlin/app/cash/licensee/SpdxLicensesGeneratorTest.kt

+import assertk.assertions.isNull
+import kotlin.test.Test
+
+class SpdxLicensesGeneratorTest {


Suggested change

class SpdxLicensesGeneratorTest {

@Suppress("HttpUrlsUsage")

class SpdxLicensesGeneratorTest {

JakeWharton

Will try to review the rest tonight

JakeWharton · 2024-04-03T22:39:15Z

build.gradle

-  task.doLast {
-    def destFile = new File(destDir, 'licenses.json')
-    def json = new JsonSlurper().parse(destFile)
-    json.licenses = json.licenses.sort { a,b -> a.licenseId <=> b.licenseId }


Sorry I COMPLETELY forgot that I was doing this. Maybe we do need sort... I thought they were finally sorting because they said they would.

Reverting bef2c7b is easy, but on the other hand, we could test it with the next license update.

Sorry I lost track of this PR.

Yeah we need to revert. It's definitely not sorted, despite me asking.

JakeWharton · 2024-06-24T02:55:53Z

Still very much open to merging this if you want to fix the merge conflict and revert that commit. If not, I'll try and find some time to do it here soon.

hfhbd · 2024-06-24T17:38:59Z

I am open for a merge too, will do solve the conflicts.

This reverts commit bef2c7b.

This reverts commit a63231c.

…on 1.7.0

Generate Spdx licenses

8fb66d5

JakeWharton reviewed Mar 30, 2024

View reviewed changes

hfhbd added 2 commits March 30, 2024 11:05

Adopt code review changes

c6d15c8

Add download task

8874cbd

Goooler reviewed Apr 2, 2024

View reviewed changes

Download the file directly

bef2c7b

JakeWharton reviewed Apr 3, 2024

View reviewed changes

Goooler mentioned this pull request Apr 16, 2024

Fallback more URL cases #239

Open

hfhbd added 4 commits July 7, 2024 19:28

Revert "Download the file directly"

a63231c

This reverts commit bef2c7b.

Revert "Revert "Download the file directly""

06a9652

This reverts commit a63231c.

Merge remote-tracking branch 'origin/trunk' into generateSpdxLicenses

c0ffaf2

Override kotlin version in build-logic to support kotlinx-serializati…

d3da860

…on 1.7.0

JakeWharton merged commit 0647191 into cashapp:trunk Jul 23, 2024
2 checks passed

StefMa mentioned this pull request Oct 4, 2024

false positive report with 1.11.0 Unkown license URL #364

Closed

hfhbd deleted the generateSpdxLicenses branch October 20, 2024 21:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Download and generate Spdx licenses #316

Download and generate Spdx licenses #316

hfhbd commented Mar 29, 2024 •

edited

Loading

JakeWharton left a comment

JakeWharton Mar 30, 2024

JakeWharton Mar 30, 2024

hfhbd Mar 30, 2024

JakeWharton Mar 30, 2024

JakeWharton commented Mar 30, 2024 •

edited

Loading

hfhbd commented Mar 31, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

Goooler Apr 2, 2024

JakeWharton left a comment

JakeWharton Apr 3, 2024

hfhbd Apr 4, 2024

JakeWharton Jun 24, 2024

JakeWharton commented Jun 24, 2024

hfhbd commented Jun 24, 2024

	internal val defaultFallbackUrls: FallbackBuilder.() -> Unit = {
	@Suppress("HttpUrlsUsage")
	internal val defaultFallbackUrls: FallbackBuilder.() -> Unit = {

	repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
	repositoriesMode = RepositoriesMode.FAIL_ON_PROJECT_REPOS

	class SpdxLicensesGeneratorTest {
	@Suppress("HttpUrlsUsage")
	class SpdxLicensesGeneratorTest {

Download and generate Spdx licenses #316

Download and generate Spdx licenses #316

Conversation

hfhbd commented Mar 29, 2024 • edited Loading

JakeWharton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JakeWharton commented Mar 30, 2024 • edited Loading

hfhbd commented Mar 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JakeWharton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JakeWharton commented Jun 24, 2024

hfhbd commented Jun 24, 2024

hfhbd commented Mar 29, 2024 •

edited

Loading

JakeWharton commented Mar 30, 2024 •

edited

Loading