Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[transform.jinja] Properly use jinjava OSGi #17358

Merged
merged 1 commit into from
Sep 4, 2024
Merged

[transform.jinja] Properly use jinjava OSGi #17358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions bundles/org.openhab.binding.mqtt.homeassistant/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,16 @@
<version>${project.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.hubspot.jinjava</groupId>
<artifactId>jinjava</artifactId>
<version>2.7.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.re2j</groupId>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this use the osgiified version too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The difference between an OSGi bundle a a non-OSGi bundle is only the content of the MANIFEST.MF. In the case of an OSGi bundle the manifest contains a list of imported and exported packages, allowing the OSGi framework to decide what is needed to get this bundle running. What is done in the osgiify repository is essentially unpacking the .jar, examining the classes and creating a list of needed and provided packages, putting that together in a new MANIFEST.MF and finally package it again in a .jar. So from the classes contained, the osgiified bundle and the original bundle are the same. The additional statements are not used in the maven build, so we can stick to the original version.

The feature-verification checks if all required packages are available at runtime (i.e. it could wire all import statements to bundles). It takes the framework bundles (the openHAB core runtime bundles) and all bundles declared in the feature.xml to do this and there the additional statements are needed, otherwise it wouldn't know what is provided by the jinjava bundle, so we need to use the osgiified version.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the details, this helped me to get a better understanding of how this fits together.

<artifactId>re2j</artifactId>
<version>1.2</version>
</dependency>
</dependencies>
</project>
Empty file added bundles/org.openhab.transform.jinja/noEmbedDependencies.profile
View file
Open in desktop
Empty file.
17 changes: 5 additions & 12 deletions bundles/org.openhab.transform.jinja/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,16 @@

<name>openHAB Add-ons :: Bundles :: Transformation Service :: Jinja</name>

<properties>
<bnd.importpackage>
javax.annotation.*;resolution:=optional,com.googlecode.ipv6.*;resolution:=optional,ch.obermuhlner.math.big.*;resolution:=optional,com.google.common.*;resolution:=optional,com.fasterxml.jackson.*;resolution:=optional,org.jsoup.*;resolution:=optional,org.apache.commons.*;resolution:=optional,org.apache.commons.net.*;resolution:=optional
</bnd.importpackage>
<dep.noembedding>jackson-annotations,jackson-databind,jackson-core,jackson-dataformat-yaml,commons-lang3,commons-net</dep.noembedding>
</properties>

<dependencies>
<dependency>
<groupId>org.openhab.osgiify</groupId>
<artifactId>com.hubspot.jinjava.jinjava</artifactId>
<groupId>com.hubspot.jinjava</groupId>
<artifactId>jinjava</artifactId>
<version>2.7.2</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.openhab.osgiify</groupId>
<artifactId>com.google.re2j.re2j</artifactId>
<groupId>com.google.re2j</groupId>
<artifactId>re2j</artifactId>
<version>1.2</version>
<scope>compile</scope>
</dependency>
Expand Down Expand Up @@ -68,7 +61,7 @@
<groupId>org.jsoup</groupId>
<artifactId>jsoup</artifactId>
<version>1.15.3</version>
<scope>provided</scope>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
Expand Down
4 changes: 3 additions & 1 deletion bundles/org.openhab.transform.jinja/src/main/feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
<feature name="openhab-transformation-jinja" description="Jinja Transformation" version="${project.version}">
<feature>openhab-runtime-base</feature>
<feature dependency="true">openhab.tp-commons-net</feature>
<bundle dependency="true">mvn:org.apache.commons/commons-lang3/3.4</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/com.hubspot.jinjava.jinjava/2.7.2_0</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/com.google.re2j.re2j/1.2</bundle>
<bundle dependency="true">mvn:ch.obermuhlner/big-math/2.3.2</bundle>
<bundle start-level="75">mvn:org.openhab.addons.bundles/org.openhab.transform.jinja/${project.version}</bundle>
</feature>
</features>