feat: implement Jlink plugin #951

vpa1977 · 2025-01-06T03:13:52Z

This MR resolves #891

It adds jlink plugin along with unit and integration tests and plugin documentation.

Have you signed the CLA?
Have you added an entry to the changelog (docs/reference/changelog.rst)?

Introduce jlink plugin to create Java runtime for the application. canonical#891

Add initial documentation for the jlink plugin.

.github/workflows/tests.yaml

craft_parts/plugins/jlink_plugin.py

The JAVA_HOME is prepended to the classpath and if defined overrides JDK that is used by jlink plugin. The jlink_java_version option is dropped as the version is determined by the jar version.

- Add JAVA_HOME usage - drop jlink_java_version

…ink-plugin

The property is dropped from the plugin. Drop the test.

tigarmo

thanks!

craft_parts/plugins/jlink_plugin.py

docs/common/craft-parts/reference/plugins/jlink_plugin.rst

docs/reference/changelog.rst

mr-cal

Nice work, this is looking good.

craft_parts/plugins/jlink_plugin.py

docs/common/craft-parts/reference/plugins/jlink_plugin.rst

tests/unit/plugins/test_jlink_plugin.py

docs/reference/changelog.rst

medubelko

There are some remaining YAML indentation quirks.

docs/common/craft-parts/reference/plugins/jlink_plugin.rst

docs/reference/changelog.rst

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

Move changelog entry to the new version

mr-cal

Thanks!

@vpa1977, have you tested building a simple snap, rock, or charm with the jlink plugin? I'm happy to publish a version of snapcraft with this plugin to make it easy.

explicitly disable debug symbols, headers and man pages in the runtime image.

…ink-plugin

vpa1977 · 2025-01-29T04:19:17Z

Thanks!

@vpa1977, have you tested building a simple snap, rock, or charm with the jlink plugin? I'm happy to publish a version of snapcraft with this plugin to make it easy.

I have made a test PR canonical/rockcraft#797 that adds a smoke for jlink plugin to rockcraft.

I had to push some amendment to docs and default jlink options, so it is probably worth looking at.

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

…ks in Rockcraft. (#993) * style: autoformat * style: fix spelling * build(deps): fix dependencies to make tests succeed * style: adjust pylint configuration to make lint pass * ci: install chisel v0.10.0 * fix: chisel tests on 20.04 * style: autoformat * style: fix spelling * build(deps): fix dependencies to make tests succeed * style: adjust pylint configuration to make lint pass * ci: install chisel v0.10.0 * fix: chisel tests on 20.04 * fix: pyright * fix(ci): 20.04 packages * tests: create integration tests for talking to snapd * build(deps): replace requests-unixsocket with requests-unixsocket2 Fixes #852 * fix: bump python version * chore: bump version to 1.19.8 * tests: create integration tests for talking to snapd * build(deps): replace requests-unixsocket with requests-unixsocket2 * fix: bump python version * Bump version: 1.25.2 → 1.25.3 * style: fix linting errors * feat: add an API for registering source types (#927) This provides a pair of functions (sources.register, sources.unregister) for registering and unregistering source types. This differs slightly from plugin registration in current sources cannot be removed. * build: migrate to pyproject.toml (#902) Removes dependency on bumpversion in favor of git tags for versioning. Co-authored-by: Sergio Schvezov <sergio.schvezov@canonical.com> * build(deps): update dependency myst-parser to v4 (#871) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * feat: use "craft.git" for git where possible (#925) If "craft.git" is available on the PATH, use it. Otherwise, fallback to "git". Fixes #900 * doc: create new how-to on creating a plugin (#928) * feat: add uv plugin (#930) * fix: remove captured message on error (#937) Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com> * docs: move changelog, add PR task (#942) * docs: move changelog to reference Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> * ci: add PR task for changelog updates Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> --------- Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> * feat(plugins/poetry): add poetry and pip extra args (#940) This allows more customisation of the poetry and pip commands for advanced users. * docs(changelog): add 2.2.0 changes (#941) Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> * doc: update docs with extra ref anchors (#945) * tests: deduplicate tests for python-based plugins (#947) * docs: clarify poetry-with field (#946) Co-authored-by: Alex Lowe <alex.lowe@canonical.com> * chore: fix some small pyproject errors, include uv.lock (#955) The pyproject file referenced some deprecated Ruff linter rules and incorrectly formatted the git describe command parameter, which had to be an array. This commit fixes both * fix: make uv plugin re-entrant on code changes (#956) * fix: correct git versioning error (#957) * build(deps): update dependency mypy to ~=1.14.1 (#958) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(docs): include poetry links as a target (#960) This allows applications that have their own custom poetry reference to include all the default links by adding the following to the bottom of their poetry plugin reference: .. include:: /common/craft-parts/reference/plugins/poetry_plugin.rst :start-after: .. _craft_parts_poetry_links: Signed-off-by: Alex Lowe <alex.lowe@canonical.com> * style: fix linting issues for ruff 0.9 (#969) * build(deps): update bugfixes (#952) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ci: replace Renovate config with starflow (#968) Co-authored-by: Callahan <callahan.kovacs@canonical.com> * docs: update docstring for maven plugin (#971) Co-authored-by: Callahan <callahan.kovacs@canonical.com> Co-authored-by: Alex Lowe <alex.lowe@canonical.com> * feat(executor): allow capturing error message from scriptlets (#966) * change craftctl channel to socket Change to craftctl communication channel from named pipes to unix sockets to make it easier to consolidate the ctl server and error stream capture. * allow using process selector with custom handlers Process execution runs a selector to obtain data from i/o streams to obtain the isolated error output. Allow this selection loop run on a caller-specified selector with handlers registered to also process interactions with craftctl. * change scriptlet environment script name Step execution environment is step-specific, and the existing environment.sh script is for the build step only. Rename the file containing the scriptlet environment to avoid confusion with the existing file (which may potentially have a different payload). * force select selector Using DefaultSelector fails in jammy with Python 3.10. It seems that this specific version picks a different selector, or there's some problem with SelectSelector that prevents it from working as expected. --------- Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> * docs: update changelog (#984) Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> * fix: use source-subdir in go-use plugin It's possible, and somewhat common, for a go module to be defined inside a repo's subdir; in this case we can define source-subdir, but the go-use plugin needs to use this - otherwise the repo root gets used. Fixes #978 * docs: fix changelog, add go-use bugfix * feat(PartSpec): add source-channel attribute (#981) Signed-off-by: Dariusz Duda <dariusz.duda@canonical.com> * docs(changelog): finalize changelog for 2.4.0 (#988) Signed-off-by: Dariusz Duda <dariusz.duda@canonical.com> * fix: don't modify 'prefix' for relocatable pkg-config files (#977) A relocatable `.pc` file has a `prefix` key beginning with `${pcfiledir}`. The `prefix` key is not modified if the `.pc` file is relocatable. * fix(tests): don't fail if you have additional JREs (#986) Fixes #985 * docs(changelog): finalize changelog for 2.4.1 (#990) Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> * feat: craftctl chroot command * docs: update and complete the step execution environment (#949) * docs: update and complete the step execution environment This adds a large number of missing environment variables from the step execution environment and updates the information about CRAFT_TARGET_ARCH and CRAFT_ARCH_TRIPLET being deprecated. Co-authored-by: Callahan <callahan.kovacs@canonical.com> Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com> * fix(craft_parts/executor/step_handler.py): adjust subprocess command to stream output * fix:adjustments for linter * fix(tests/integration/lifecycle/test_craftctl.py): update expected error description * feat: add Jlink plugin (#951) Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com> Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com> Co-authored-by: Callahan Kovacs <callahan.kovacs@canonical.com> Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> * docs: correct the lifecycle step for `organize` (#996) Co-authored-by: Callahan <callahan.kovacs@canonical.com> * fix(craft_parts/utils/process.py): migrate subprocess.run to internal process.run --------- Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com> Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> Signed-off-by: Alex Lowe <alex.lowe@canonical.com> Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> Signed-off-by: Dariusz Duda <dariusz.duda@canonical.com> Co-authored-by: Alex Lowe <alex.lowe@canonical.com> Co-authored-by: Sergio Schvezov <sergio.schvezov@canonical.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com> Co-authored-by: Imani Pelton <imani.pelton@canonical.com> Co-authored-by: Callahan <callahan.kovacs@canonical.com> Co-authored-by: Carl Csaposs <carl.csaposs@canonical.com> Co-authored-by: Yanks Yoon <37652070+yanksyoon@users.noreply.github.com> Co-authored-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> Co-authored-by: Dariusz Duda <dariusz.duda@canonical.com> Co-authored-by: Sergio Costas <sergio.costas@canonical.com> Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com> Co-authored-by: Vladimir Petko <vladimir.petko@canonical.com> Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com> Co-authored-by: Michael DuBelko <michael.dubelko@canonical.com>

vpa1977 added 2 commits January 6, 2025 16:13

feat: add jlink plugin

c12302c

Introduce jlink plugin to create Java runtime for the application. canonical#891

doc: add jlink plugin documentation

cf7a732

Add initial documentation for the jlink plugin.

vpa1977 force-pushed the jlink-plugin branch from bd8c90f to cf7a732 Compare January 6, 2025 22:02

vpa1977 added 4 commits January 7, 2025 11:34

doc: amend wordlist to include jlink

e08828c

doc: include jlink plugin in toc

ef11438

doc: update wordlist for jlink plugin

555b95b

chore: install openjdk-21-jdk for jlink test

9f87a57

vpa1977 force-pushed the jlink-plugin branch from 972aaf8 to 9f87a57 Compare January 7, 2025 01:59

vpa1977 added 5 commits January 7, 2025 17:06

doc: add changelog rst

80976e8

test(jlink): add test for different java version

c629c91

lint: update formatting

52e1075

fix: include all jar files in the classpath

d447abe

test: add unit tests

30afbc8

vpa1977 marked this pull request as ready for review January 8, 2025 03:55

Merge branch 'main' into jlink-plugin

f5d65a4

tigarmo requested review from tigarmo and mr-cal January 14, 2025 12:48

tigarmo reviewed Jan 16, 2025

View reviewed changes

.github/workflows/tests.yaml Show resolved Hide resolved

craft_parts/plugins/jlink_plugin.py Outdated Show resolved Hide resolved

craft_parts/plugins/jlink_plugin.py Outdated Show resolved Hide resolved

vpa1977 added 9 commits January 20, 2025 15:06

feat: use JAVA_HOME and deduce version from it

44db443

The JAVA_HOME is prepended to the classpath and if defined overrides JDK that is used by jlink plugin. The jlink_java_version option is dropped as the version is determined by the jar version.

doc: update documentation

8af0327

- Add JAVA_HOME usage - drop jlink_java_version

Merge branch 'jlink-plugin' of github.com:vpa1977/craft-parts into jl…

a59bfb0

…ink-plugin

Merge remote-tracking branch 'upstream/main' into jlink-plugin

14ca2d3

lint: dependant -> dependent

bc74bd6

test: drop test for java version

2452b20

The property is dropped from the plugin. Drop the test.

doc: add missing words for the spellcheck

213d18f

test: drop integration test for java_version property

5922bbb

lint: drop unused import

6251ec3

vpa1977 requested a review from tigarmo January 20, 2025 05:32

tigarmo requested changes Jan 22, 2025

View reviewed changes

tigarmo requested a review from medubelko January 22, 2025 19:54

mr-cal requested changes Jan 24, 2025

View reviewed changes

medubelko requested changes Jan 24, 2025

View reviewed changes

docs/common/craft-parts/reference/plugins/jlink_plugin.rst Outdated Show resolved Hide resolved

docs/common/craft-parts/reference/plugins/jlink_plugin.rst Outdated Show resolved Hide resolved

docs/reference/changelog.rst Outdated Show resolved Hide resolved

vpa1977 and others added 6 commits January 25, 2025 12:19

Update craft_parts/plugins/jlink_plugin.py

52cc3e0

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

Update docs/common/craft-parts/reference/plugins/jlink_plugin.rst

318bf6b

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

Update docs/common/craft-parts/reference/plugins/jlink_plugin.rst

68c754d

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

Update docs/common/craft-parts/reference/plugins/jlink_plugin.rst

4fcb352

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

Update tests/unit/plugins/test_jlink_plugin.py

61e3ac2

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

Update docs/common/craft-parts/reference/plugins/jlink_plugin.rst

0bf53a5

Co-authored-by: Callahan <callahan.kovacs@canonical.com>

medubelko approved these changes Jan 24, 2025

View reviewed changes

vpa1977 added 4 commits January 25, 2025 14:04

doc: specify how to install openjdk for jlink plugin

4935f90

doc: fix typo in jlink link

b19af95

Merge branch 'main' into jlink-plugin

e472123

doc: update changelog

07aaeb0

Move changelog entry to the new version

vpa1977 requested a review from mr-cal January 25, 2025 02:03

mr-cal approved these changes Jan 27, 2025

View reviewed changes

vpa1977 added 3 commits January 29, 2025 15:15

fix: add explicitly use jlink options

99d8bf9

explicitly disable debug symbols, headers and man pages in the runtime image.

doc: exclude jvm from staging

b65efb6

Merge branch 'jlink-plugin' of github.com:vpa1977/craft-parts into jl…

7647c59

…ink-plugin

Merge branch 'main' into jlink-plugin

fb203be

vpa1977 requested review from mr-cal, tigarmo and medubelko January 29, 2025 04:21

tigarmo approved these changes Jan 29, 2025

View reviewed changes

medubelko approved these changes Jan 29, 2025

View reviewed changes

mr-cal approved these changes Jan 29, 2025

View reviewed changes

style: black

7a38f56

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>

mr-cal added the squash label Jan 29, 2025

mr-cal merged commit ba3891a into canonical:main Jan 30, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement Jlink plugin #951

feat: implement Jlink plugin #951

vpa1977 commented Jan 6, 2025 •

edited

Loading

tigarmo left a comment

mr-cal left a comment

medubelko left a comment

mr-cal left a comment

vpa1977 commented Jan 29, 2025

feat: implement Jlink plugin #951

feat: implement Jlink plugin #951

Conversation

vpa1977 commented Jan 6, 2025 • edited Loading

tigarmo left a comment

Choose a reason for hiding this comment

mr-cal left a comment

Choose a reason for hiding this comment

medubelko left a comment

Choose a reason for hiding this comment

mr-cal left a comment

Choose a reason for hiding this comment

vpa1977 commented Jan 29, 2025

vpa1977 commented Jan 6, 2025 •

edited

Loading