Use jakarta #25

brinxmat · 2024-12-04T17:09:27Z

Uses an xjc gradle plugin that has been updated recently (previous is basically dead)
Does as much as possible in groovy, rather than via the plugin, which hopefully means we can drop-in replacement since no special functionality is required
jakarta is now used

brinxmat · 2024-12-04T17:12:04Z

datacite-transform/build.gradle

 plugins {
    id 'java'
-    id "org.unbroken-dome.xjc" version "2.0.0"


This was last updated four years ago, a PR was created by a third party for jakarta update in recent time, but nothing has been commented or merged in four years.

brinxmat · 2024-12-04T17:12:45Z

datacite-transform/build.gradle

 plugins {
    id 'java'
-    id "org.unbroken-dome.xjc" version "2.0.0"
+    id("io.github.alexpercont.xjc-plugin") version "1.1"


This is not necessarily the best choice, but it is the most recent and supports jakarta.

The download plugin is a common choice.

I think @ketilaa have a point regarding the xsd and if we also don't need to rely on a plugin with short track record and only one contributor, that would be nice. If download is not a requirement, would it be easier to find an alternative?

We changed the plugin to another one-person (with two personalities) project, but with more users

brinxmat · 2024-12-04T17:14:53Z

datacite-transform/build.gradle

+    def xml = new groovy.xml.XmlSlurper().parseText(source.getText())

-    if (!file(schemaDir + urlFile).exists()) {
-        Files.createFile(Paths.get(schemaDir + urlFile))
-                .text = "https://schema.datacite.org/meta/kernel-${schemaVersion}/metadata.xsd"
+    return xml.'**'.findAll {
+        it.name() == 'include' || it.name() == 'import'
+    }.collect {
+        it.@'schemaLocation'
    }


Here, we're extracting the URIs of the XML files that we need to gather in order to be able to build.

brinxmat · 2024-12-04T17:15:45Z

datacite-transform/build.gradle

+    def uri = "https://schema.datacite.org/meta/kernel-${SCHEMA_VERSION}/${path}"
+    def file = file(SCHEMA_DIR.toURI().toString() + '/' + path)
+
+    if (!file.exists()) {


We don't need to download if we already have.

brinxmat · 2024-12-04T17:16:23Z

datacite-transform/build.gradle

+        }
+        DID_DOWNLOAD.put(path, true)
+    } else {
+        DID_DOWNLOAD.put(path, false)


If we don't, we give the message that you might want to clean the source to override.

brinxmat · 2024-12-04T17:16:52Z

datacite-transform/build.gradle

+    from "${layout.buildDirectory}/classes/java/main"
+}
+
+tasks.named('sourcesJar') {


Necessary to provide explicit dependency here.

brinxmat · 2024-12-04T17:17:05Z

datacite-transform/build.gradle

 }

-System.setProperty('javax.xml.accessExternalSchema', 'all')


This is what we cannot do

brinxmat · 2024-12-04T17:17:21Z

datacite-transform/src/main/java/no/unit/nva/transformer/Transformer.java

+import jakarta.xml.bind.JAXBContext;
+import jakarta.xml.bind.JAXBException;
+import jakarta.xml.bind.Marshaller;


ketilaa · 2024-12-05T07:09:12Z

Have we considered just downloading the schema files? It is somewhat risky to rely on external content during a build, and a given build might be hard to reproduce: https://reproducible-builds.org

torbjokv · 2024-12-05T07:53:48Z

build.gradle


-    sourceCompatibility = JavaVersion.VERSION_11
-    targetCompatibility = JavaVersion.VERSION_11


torbjokv · 2024-12-05T08:08:26Z

datacite-transform/build.gradle

 plugins {
    id 'java'
-    id "org.unbroken-dome.xjc" version "2.0.0"
+    id("io.github.alexpercont.xjc-plugin") version "1.1"


I think @ketilaa have a point regarding the xsd and if we also don't need to rely on a plugin with short track record and only one contributor, that would be nice. If download is not a requirement, would it be easier to find an alternative?

github-actions · 2024-12-05T10:06:08Z

Test Results

5 tests 5 ✅ 0s ⏱️
1 suites 0 💤
1 files 0 ❌

Results for commit 099227e.

♻️ This comment has been updated with latest results.

Co-authored-by: brinxmat <789709+brinxmat@users.noreply.github.com>

codacy-production · 2024-12-05T15:04:34Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for `c8c45af`¹	✅ 0.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`c8c45af`)	Report Missing	Report Missing	Report Missing
Head commit (`099227e`)	997	427	42.83%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#25)	1	0	0.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩

brinxmat · 2024-12-05T15:18:16Z

Have we considered just downloading the schema files? It is somewhat risky to rely on external content during a build, and a given build might be hard to reproduce: https://reproducible-builds.org

@ketilaa @torbjokv @LarsV123 I will create a new PR that makes the "download" functionality a "helper" and put the XSD under version control IF AND WHEN I know the licensing status of the XSD.

Use jakarta

bd05d64

brinxmat requested review from truhacevkir, LarsV123, torbjokv and ketilaa December 4, 2024 17:09

brinxmat commented Dec 4, 2024

View reviewed changes

brinxmat requested a review from monaullah December 4, 2024 17:32

torbjokv reviewed Dec 5, 2024

View reviewed changes

Bump java version/version details in jitpack and ci

9828709

LarsV123 approved these changes Dec 5, 2024

View reviewed changes

Use different plugin

cc9abc2

torbjokv approved these changes Dec 5, 2024

View reviewed changes

ketilaa approved these changes Dec 5, 2024

View reviewed changes

brinxmat added 3 commits December 5, 2024 10:46

Remove cli warnings

f3b1595

Use PMD7

bd89ae0

Workflow is actually a workflow

d8a0854

fix: Update GitHub workflow (#26)

099227e

Co-authored-by: brinxmat <789709+brinxmat@users.noreply.github.com>

brinxmat merged commit e2d7046 into develop Dec 5, 2024
6 checks passed

brinxmat deleted the use-jakarta branch December 5, 2024 15:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use jakarta #25

Use jakarta #25

brinxmat commented Dec 4, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

torbjokv Dec 5, 2024

brinxmat Dec 5, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

brinxmat Dec 4, 2024

ketilaa commented Dec 5, 2024

torbjokv Dec 5, 2024

torbjokv Dec 5, 2024

github-actions bot commented Dec 5, 2024 •

edited

Loading

codacy-production bot commented Dec 5, 2024

brinxmat commented Dec 5, 2024

		}

		System.setProperty('javax.xml.accessExternalSchema', 'all')


		sourceCompatibility = JavaVersion.VERSION_11
		targetCompatibility = JavaVersion.VERSION_11

Use jakarta #25

Use jakarta #25

Conversation

brinxmat commented Dec 4, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ketilaa commented Dec 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 5, 2024 • edited Loading

Test Results

codacy-production bot commented Dec 5, 2024

Coverage summary from Codacy

Footnotes

brinxmat commented Dec 5, 2024

github-actions bot commented Dec 5, 2024 •

edited

Loading