iTools packager: license files and misc files #3654

jeandemanged · 2025-11-13T18:57:41Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Bugfix & Feature

Rework of #3443.

What is the current behavior?

Add Third-party licenses #3443 has issue of looking in parent folder, hence copying licences and 3rd party files does not work for example for powsybl-distribution where we encounter:

[INFO] Copy file /home/runner/work/powsybl-distribution/powsybl-distribution/resources/XIIDM/eurostag-tutorial-example1.xml to /home/runner/work/powsybl-distribution/powsybl-distribution/target/powsybl-distribution-2025.2.1/etc
Warning:  License file /home/runner/work/powsybl-distribution/LICENSE.txt not found
Warning:  License file /home/runner/work/powsybl-distribution/THIRD-PARTY.txt not found
[INFO] Zip package

We use maven-plugin-testing-harness v3.3.0

What is the new behavior (if this is a feature change)?

User can configure the itools packager with explicit file locations for license and third party files. licenseFile and thirdPartyFile are optional. If not provided, the packager will look for LICENSE.txt, LICENSE, THIRD-PARTY and THIRD-PARTY.txt in the project directory as well as its parent directory.

                <configuration>
                    <licenseFile>LICENSE.txt</licenseFile>
                    <thirdPartyFile>THIRD-PARTY.txt</thirdPartyFile>
                </configuration>

In case no file could be found, a log indicates all attempted locations for license and third party.

User can configure the itools packager to copy any desired file via plugin configuration at the package root:

                <configuration>
                    <copyToPackageRoot>
                        <files>
                            <file>${project.basedir}/path/to/some/file.txt</file>
                        </files>
                    </copyToPackageRoot>
                </configuration>

We use maven-plugin-testing-harness v3.4.0 making tests much cleaner and easier with junit-jupiter instead of junit-vintage-engine

Does this PR introduce a breaking change or deprecate an API?

Yes

If yes, please check if the following requirements are fulfilled

The Breaking Change or Deprecated label has been added
The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Other information:

Signed-off-by: Damien Jeandemange <[email protected]>

rolnico · 2025-11-18T08:00:32Z

I think that the issue here is more that the "child project" (powsybl-distribution in your example) does not have a LICENSE.txt and a THIRD-PARTY.txt. According to some licenses, we should provide those files as soon as we make an executable (for example), that's why I hardcoded the two files during the itools generation.
However:

adding the possibility to add more files is nice to have
Fixing the paths of the files is also of course interesting (looking into the parent folder should be done only if the files are not found in the project directory level)

jeandemanged · 2025-11-18T09:09:40Z

I think that the issue here is more that the "child project" (powsybl-distribution in your example) does not have a LICENSE.txt and a THIRD-PARTY.txt. According to some licenses, we should provide those files as soon as we make an executable (for example), that's why I hardcoded the two files during the itools generation. However:

adding the possibility to add more files is nice to have

Fixing the paths of the files is also of course interesting (looking into the parent folder should be done only if the files are not found in the project directory level)

Hi @rolnico

The issue for powsybl-distribution is that current implementation looks in parent folder always, so even if these files were added, they would not be found at all.

The warning in GitLab CI is

Warning:  License file /home/runner/work/powsybl-distribution/LICENSE.txt not found
Warning:  License file /home/runner/work/powsybl-distribution/THIRD-PARTY.txt not found

But what can be added to powsybl-distribution is:
/home/runner/work/powsybl-distribution/powsybl-distribution/LICENSE.txt
not
/home/runner/work/powsybl-distribution/LICENSE.txt

rolnico · 2025-11-18T09:31:53Z

I think that the issue here is more that the "child project" (powsybl-distribution in your example) does not have a LICENSE.txt and a THIRD-PARTY.txt. According to some licenses, we should provide those files as soon as we make an executable (for example), that's why I hardcoded the two files during the itools generation. However:

adding the possibility to add more files is nice to have

Fixing the paths of the files is also of course interesting (looking into the parent folder should be done only if the files are not found in the project directory level)

Hi @rolnico

The issue for powsybl-distribution is that current implementation looks in parent folder always, so even if these files were added, they would not be found at all.

The warning in GitLab CI is
Warning:  License file /home/runner/work/powsybl-distribution/LICENSE.txt not found
Warning:  License file /home/runner/work/powsybl-distribution/THIRD-PARTY.txt not found
But what can be added to powsybl-distribution is: /home/runner/work/powsybl-distribution/powsybl-distribution/LICENSE.txt not /home/runner/work/powsybl-distribution/LICENSE.txt

Exactly, that's why I said that fixing the paths could be interesting.
What I'm wondering is: can we make adding these files a requirement while not providing fixed paths? Maybe having a specific parameter for each and, if it's not specified by the user, looking for the files in the standard directories (project + parent)?

sonarqubecloud · 2025-12-04T10:46:12Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Signed-off-by: Damien Jeandemange <[email protected]>

jeandemanged · 2026-01-08T16:21:16Z

...
... Maybe having a specific parameter for each and, if it's not specified by the user, looking for the files in the standard directories (project + parent)?

Hi @rolnico , done as per your suggestion above, let me know

rolnico

I would make some changes: if the user specifies a license or 3rd party file, I think we should not look for a default file if the users file does not exist.
What do you think of that?

rolnico · 2026-01-08T16:13:03Z

itools-packager/src/test/resources/test-maven-project-lic-parent-dir/submodule/pom.xml

+                    <licenseFile>myLic.txt</licenseFile>
+                    <thirdPartyFile>my3rdParties.txt</thirdPartyFile>


In this case, the files do not exist, but the standard files exist in the parent folder and we'll use those files. Is that the expected behavior? Or should we throw an exception when files with the expected names are not found?

was intended, changed as you wanted.
you may change further if needed.

rolnico · 2026-01-08T16:45:19Z

itools-packager/src/main/java/com/powsybl/itools/ItoolsPackagerMojo.java

    private void addLicenseFiles(Path packageDir) {
        // List of the license files to copy
-        List<String> licenseFiles = Arrays.asList("LICENSE.txt", "THIRD-PARTY.txt");
+        Path projectRoot = Path.of(project.getBasedir().getPath());


Suggested change

Path projectRoot = Path.of(project.getBasedir().getPath());

Path projectRoot = project.getBasedir().toPath();

rolnico · 2026-01-08T16:45:37Z

itools-packager/src/main/java/com/powsybl/itools/ItoolsPackagerMojo.java

+        List<Path> candidateLicenseFiles = Stream.of(licenseFile, "LICENSE.txt", "../LICENSE.txt")
+                .filter(Objects::nonNull).map(projectRoot::resolve).toList();


Suggested change

List<Path> candidateLicenseFiles = Stream.of(licenseFile, "LICENSE.txt", "../LICENSE.txt")

.filter(Objects::nonNull).map(projectRoot::resolve).toList();

List<Path> candidateLicenseFiles = getFilePathList(licenseFile, "LICENSE", projectRoot);

rolnico · 2026-01-08T16:47:16Z

itools-packager/src/main/java/com/powsybl/itools/ItoolsPackagerMojo.java

+        List<Path> candidateThirdPartyFiles = Stream.of(thirdPartyFile, "THIRD-PARTY.txt", "../THIRD-PARTY.txt")
+                .filter(Objects::nonNull).map(projectRoot::resolve).toList();
+        addLicenseFile(packageDir, candidateThirdPartyFiles);
+    }


I would suggest a change, to only look for default files if no license/3rd party file was given by the user:

Suggested change

List<Path> candidateThirdPartyFiles = Stream.of(thirdPartyFile, "THIRD-PARTY.txt", "../THIRD-PARTY.txt")

.filter(Objects::nonNull).map(projectRoot::resolve).toList();

addLicenseFile(packageDir, candidateThirdPartyFiles);

}

List<Path> candidateThirdPartyFiles = getFilePathList(thirdPartyFile, "THIRD-PARTY", projectRoot);

addLicenseFile(packageDir, candidateThirdPartyFiles);

}

private List<Path> getFilePathList(String fileName, String defaultFileNameBase, Path projectRoot) {

if (fileName != null) {

return List.of(

projectRoot.resolve(fileName),

projectRoot.resolve("..").resolve(fileName)

);

}

// Search for default names

return Stream.of("", ".txt")

.flatMap(ext -> Stream.of(

projectRoot.resolve(defaultFileNameBase + ext),

projectRoot.resolve("..").resolve(defaultFileNameBase + ext)

))

.toList();

}

rolnico · 2026-01-08T16:48:03Z

itools-packager/src/test/java/com/powsybl/itools/ItoolsPackagerMojoTest.java

-        FileUtils.deleteDirectory(target2); // cleanup
+        String target = project.getBuild().getDirectory();
+        assertTrue(new File(target, DEFAULT_PACKAGE_NAME + ".zip").exists());
+        assertTrue(new File(target, DEFAULT_PACKAGE_NAME + "/LICENSE.txt").exists());


Suggested change

assertTrue(new File(target, DEFAULT_PACKAGE_NAME + "/LICENSE.txt").exists());

assertFalse(new File(target, DEFAULT_PACKAGE_NAME + "/LICENSE.txt").exists());

if you change also in the test pom.xml

rolnico · 2026-01-08T16:48:59Z

itools-packager/src/test/resources/test-maven-project-lic-parent-dir/submodule/pom.xml

+                </executions>
+                <configuration>
+                    <licenseFile>myLic.txt</licenseFile>
+                    <thirdPartyFile>my3rdParties.txt</thirdPartyFile>


Suggested change

<thirdPartyFile>my3rdParties.txt</thirdPartyFile>

remove this to test the case where only one file is specified (and since it does not exist, the test is modified too)

Signed-off-by: Damien Jeandemange <[email protected]>

sonarqubecloud · 2026-01-08T17:28:29Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

rolnico

LGTM

iTools packager: copy files at package root

a2c13bc

Signed-off-by: Damien Jeandemange <[email protected]>

jeandemanged added iTools Breaking Change API is broken labels Nov 17, 2025

jeandemanged added this to Release 12/2025 Nov 17, 2025

github-project-automation bot moved this to TODO in Release 12/2025 Nov 17, 2025

jeandemanged moved this from TODO to Waiting for review in Release 12/2025 Nov 17, 2025

jeandemanged added the Release 12/2025 label Nov 17, 2025

test

bb20a54

Signed-off-by: Damien Jeandemange <[email protected]>

jeandemanged marked this pull request as ready for review November 17, 2025 13:55

jeandemanged requested review from olperr1 and rolnico November 17, 2025 13:55

fix

a910568

Signed-off-by: Damien Jeandemange <[email protected]>

Merge branch 'main' into itools-packager-copyToPackageRoot

f599ea4

jeandemanged removed the Release 12/2025 label Dec 4, 2025

jeandemanged removed this from Release 12/2025 Dec 4, 2025

Merge branch 'main' into itools-packager-copyToPackageRoot

901e878

jeandemanged added the Release 03/2026 label Dec 4, 2025

jeandemanged added this to Release 03/2026 Dec 4, 2025

github-project-automation bot moved this to TODO in Release 03/2026 Dec 4, 2025

jeandemanged moved this from TODO to In Progress in Release 03/2026 Dec 4, 2025

jeandemanged added 2 commits January 8, 2026 15:48

Merge branch 'main' into itools-packager-copyToPackageRoot

c28f363

review comments

6bcb6ca

Signed-off-by: Damien Jeandemange <[email protected]>

jeandemanged removed the Breaking Change API is broken label Jan 8, 2026

jeandemanged changed the title ~~iTools packager: copy files at package root~~ iTools packager: license files and misc files Jan 8, 2026

doc

30538e1

Signed-off-by: Damien Jeandemange <[email protected]>

rolnico requested changes Jan 8, 2026

View reviewed changes

github-project-automation bot moved this from In Progress to Waiting for review in Release 03/2026 Jan 8, 2026

change

cbeca5a

Signed-off-by: Damien Jeandemange <[email protected]>

rolnico approved these changes Jan 9, 2026

View reviewed changes

github-project-automation bot moved this from Waiting for review to Approved in Release 03/2026 Jan 9, 2026

		<licenseFile>myLic.txt</licenseFile>
		<thirdPartyFile>my3rdParties.txt</thirdPartyFile>

	Path projectRoot = Path.of(project.getBasedir().getPath());
	Path projectRoot = project.getBasedir().toPath();

		List<Path> candidateLicenseFiles = Stream.of(licenseFile, "LICENSE.txt", "../LICENSE.txt")
		.filter(Objects::nonNull).map(projectRoot::resolve).toList();

	List<Path> candidateLicenseFiles = Stream.of(licenseFile, "LICENSE.txt", "../LICENSE.txt")
	.filter(Objects::nonNull).map(projectRoot::resolve).toList();
	List<Path> candidateLicenseFiles = getFilePathList(licenseFile, "LICENSE", projectRoot);

-        List<Path> candidateThirdPartyFiles = Stream.of(thirdPartyFile, "THIRD-PARTY.txt", "../THIRD-PARTY.txt")
-                .filter(Objects::nonNull).map(projectRoot::resolve).toList();
-        addLicenseFile(packageDir, candidateThirdPartyFiles);
-    }
+        List<Path> candidateThirdPartyFiles = getFilePathList(thirdPartyFile, "THIRD-PARTY", projectRoot);
+        addLicenseFile(packageDir, candidateThirdPartyFiles);
+    }
+    private List<Path> getFilePathList(String fileName, String defaultFileNameBase, Path projectRoot) {
+        if (fileName != null) {
+            return List.of(
+                projectRoot.resolve(fileName),
+                projectRoot.resolve("..").resolve(fileName)
+            );
+        }
+        // Search for default names
+        return Stream.of("", ".txt")
+            .flatMap(ext -> Stream.of(
+                projectRoot.resolve(defaultFileNameBase + ext),
+                projectRoot.resolve("..").resolve(defaultFileNameBase + ext)
+            ))
+            .toList();
+    }

	assertTrue(new File(target, DEFAULT_PACKAGE_NAME + "/LICENSE.txt").exists());
	assertFalse(new File(target, DEFAULT_PACKAGE_NAME + "/LICENSE.txt").exists());

iTools packager: license files and misc files #3654

Are you sure you want to change the base?

iTools packager: license files and misc files #3654

Uh oh!

Conversation

jeandemanged commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rolnico commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeandemanged commented Nov 18, 2025

Uh oh!

rolnico commented Nov 18, 2025

Uh oh!

sonarqubecloud bot commented Dec 4, 2025

Quality Gate passed

Uh oh!

jeandemanged commented Jan 8, 2026

Uh oh!

rolnico left a comment

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

jeandemanged Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

rolnico Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 8, 2026

Quality Gate passed

Uh oh!

rolnico left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeandemanged commented Nov 13, 2025 •

edited

Loading

rolnico commented Nov 18, 2025 •

edited

Loading

jeandemanged Jan 8, 2026 •

edited

Loading