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

Jump to bottom

[jsonpath] Upgrade dependencies and some cleanup #16365

Merged
merged 1 commit into from
Feb 4, 2024
Merged

[jsonpath] Upgrade dependencies and some cleanup #16365

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 12 additions & 5 deletions bundles/org.openhab.transform.jsonpath/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,39 @@
<name>openHAB Add-ons :: Bundles :: Transformation Service :: JSonPath</name>

<properties>
<bnd.importpackage>!org.apache.tapestry5.json.*,!org.codehaus.jettison.json.*,!org.json.*,!com.fasterxml.jackson.*</bnd.importpackage>
<bnd.importpackage>!org.apache.tapestry5.json.*,!org.codehaus.jettison.json.*,!org.json.*,!com.fasterxml.jackson.*,!jakarta.json.*</bnd.importpackage>
</properties>

<dependencies>
<dependency>
<groupId>com.jayway.jsonpath</groupId>
<artifactId>json-path</artifactId>
<version>2.5.0</version>
<version>2.9.0</version>
<scope>compile</scope>
<exclusions>
<exclusion>
<!-- Exclude slf4j-api to prevent its scope being changed from 'provided' to 'runtime' -->
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.ow2.asm</groupId>
<artifactId>asm</artifactId>
<version>5.0.4</version>
<version>9.3</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>net.minidev</groupId>
<artifactId>accessors-smart</artifactId>
<version>1.2</version>
<version>2.5.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>net.minidev</groupId>
<artifactId>json-smart</artifactId>
<version>2.3</version>
<version>2.5.0</version>
<scope>compile</scope>
</dependency>
</dependencies>
Expand Down
14 changes: 6 additions & 8 deletions .../src/main/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@
import com.jayway.jsonpath.PathNotFoundException;

/**
* <p>
* The implementation of {@link TransformationService} which transforms the input by JSonPath Expressions.
*
* @author Gaël L'hopital
* @author Sebastian Janzen
* The implementation of a {@link TransformationService} which transforms the input by JSonPath Expressions.
*
* @author Gaël L'hopital - Initial contribution
* @author Sebastian Janzen - Initial contribution
*/
@NonNullByDefault
@Component(property = { "openhab.transform=JSONPATH" })
Expand Down Expand Up @@ -68,7 +66,7 @@ public class JSonPathTransformationService implements TransformationService {
logger.debug("transformation resulted in '{}'", transformationResult);
if (transformationResult == null) {
return null;
} else if (transformationResult instanceof List list) {
} else if (transformationResult instanceof List<?> list) {
return flattenList(list);
} else {
return transformationResult.toString();
Expand Down Expand Up @@ -98,10 +96,10 @@ private String flattenList(List<?> list) {
}

private String createNumberList(List<?> list) {
return list.stream().map(n -> String.valueOf(n)).collect(Collectors.joining(", ", "[", "]"));
return list.stream().map(String::valueOf).collect(Collectors.joining(", ", "[", "]"));
}

private String createStringList(List<?> list) {
return list.stream().map(n -> "\"" + String.valueOf(n) + "\"").collect(Collectors.joining(", ", "[", "]"));
return list.stream().map(n -> "\"" + n + "\"").collect(Collectors.joining(", ", "[", "]"));
}
}
9 changes: 3 additions & 6 deletions .../java/org/openhab/transform/jsonpath/internal/profiles/JSonPathTransformationProfile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@
/**
* Profile to offer the JSonPathTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*
* @author Stefan Triller - Initial contribution
*/
@NonNullByDefault
public class JSonPathTransformationProfile implements StateProfile {
Expand All @@ -47,10 +46,8 @@ public class JSonPathTransformationProfile implements StateProfile {
private static final String FUNCTION_PARAM = "function";
private static final String SOURCE_FORMAT_PARAM = "sourceFormat";

@NonNullByDefault({})
private final String function;
@NonNullByDefault({})
private final String sourceFormat;
private final @NonNullByDefault({}) String function;
private final @NonNullByDefault({}) String sourceFormat;

public JSonPathTransformationProfile(ProfileCallback callback, ProfileContext context,
TransformationService service) {
Expand Down
14 changes: 6 additions & 8 deletions ...rg/openhab/transform/jsonpath/internal/profiles/JSonPathTransformationProfileFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
*/
package org.openhab.transform.jsonpath.internal.profiles;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Locale;

import org.eclipse.jdt.annotation.NonNullByDefault;
Expand All @@ -31,21 +31,19 @@
import org.osgi.service.component.annotations.Reference;

/**
* Profilefactory that creates the transformation profile for the jsonpath transformation service
*
* @author Stefan Triller - initial contribution
* {@link ProfileFactory} that creates the transformation profile for the jsonpath transformation service
*
* @author Stefan Triller - Initial contribution
*/
@NonNullByDefault
@Component(service = { ProfileFactory.class, ProfileTypeProvider.class })
public class JSonPathTransformationProfileFactory implements ProfileFactory, ProfileTypeProvider {

@NonNullByDefault({})
private TransformationService service;
private @NonNullByDefault({}) TransformationService service;

@Override
public Collection<ProfileType> getProfileTypes(@Nullable Locale locale) {
return Arrays.asList(ProfileTypeBuilder.newState(JSonPathTransformationProfile.PROFILE_TYPE_UID,
return List.of(ProfileTypeBuilder.newState(JSonPathTransformationProfile.PROFILE_TYPE_UID,
JSonPathTransformationProfile.PROFILE_TYPE_UID.getId()).build());
}

Expand All @@ -57,7 +55,7 @@ public Collection<ProfileType> getProfileTypes(@Nullable Locale locale) {

@Override
public Collection<ProfileTypeUID> getSupportedProfileTypeUIDs() {
return Arrays.asList(JSonPathTransformationProfile.PROFILE_TYPE_UID);
return List.of(JSonPathTransformationProfile.PROFILE_TYPE_UID);
}

@Reference(target = "(openhab.transform=JSONPATH)")
Expand Down
1 change: 0 additions & 1 deletion bundles/org.openhab.transform.jsonpath/src/main/resources/readme.txt
View file
Open in desktop

This file was deleted.

32 changes: 17 additions & 15 deletions .../test/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@

import static org.junit.jupiter.api.Assertions.*;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.openhab.core.transform.TransformationException;

/**
* @author Gaël L'hopital - Initial contribution
*/
@NonNullByDefault
public class JSonPathTransformationServiceTest {

private JSonPathTransformationService processor;
private @NonNullByDefault({}) JSonPathTransformationService processor;

@BeforeEach
public void init() {
Expand All @@ -40,59 +42,59 @@ public void testTransformByJSon() throws TransformationException {
assertEquals("Nigel Rees", transformedResponse);
}

private static final String jsonArray = "[" + //
private static final String JSON_ARRAY = "[" + //
"{ \"id\":1, \"name\":\"bob\", \"empty\":null }," + //
"{ \"id\":2, \"name\":\"alice\" }" + //
"]";

@Test
public void testValidPath1() throws TransformationException {
String transformedResponse = processor.transform("$[0].name", jsonArray);
String transformedResponse = processor.transform("$[0].name", JSON_ARRAY);
assertEquals("bob", transformedResponse);
}

@Test
public void testValidPath2() throws TransformationException {
String transformedResponse = processor.transform("$[1].id", jsonArray);
String transformedResponse = processor.transform("$[1].id", JSON_ARRAY);
assertEquals("2", transformedResponse);
}

@Test
public void testInvalidPathThrowsException() {
assertThrows(TransformationException.class, () -> processor.transform("$$", jsonArray));
assertThrows(TransformationException.class, () -> processor.transform("$$", JSON_ARRAY));
}

@Test
public void testPathMismatchReturnNull() {
assertThrows(TransformationException.class, () -> processor.transform("$[5].id", jsonArray));
assertThrows(TransformationException.class, () -> processor.transform("$[5].id", JSON_ARRAY));
}

@Test
public void testInvalidJsonReturnNull() throws TransformationException {
public void testInvalidJsonReturnNull() {
assertThrows(TransformationException.class, () -> processor.transform("$", "{id:"));
}

@Test
public void testNullValue() throws TransformationException {
String transformedResponse = processor.transform("$[0].empty", jsonArray);
assertEquals(null, transformedResponse);
String transformedResponse = processor.transform("$[0].empty", JSON_ARRAY);
assertNull(transformedResponse);
}

@Test
public void testIndefinite_filteredToSingle() throws TransformationException {
String transformedResponse = processor.transform("$.*[?(@.name=='bob')].id", jsonArray);
public void testIndefiniteFilteredToSingle() throws TransformationException {
String transformedResponse = processor.transform("$.*[?(@.name=='bob')].id", JSON_ARRAY);
assertEquals("1", transformedResponse);
}

@Test
public void testIndefinite_notFiltered() throws TransformationException {
String transformedResponse = processor.transform("$.*.id", jsonArray);
public void testIndefiniteNotFiltered() throws TransformationException {
String transformedResponse = processor.transform("$.*.id", JSON_ARRAY);
assertEquals("[1, 2]", transformedResponse);
}

@Test
public void testIndefinite_noMatch() throws TransformationException {
String transformedResponse = processor.transform("$.*[?(@.name=='unknown')].id", jsonArray);
public void testIndefiniteNoMatch() throws TransformationException {
String transformedResponse = processor.transform("$.*[?(@.name=='unknown')].id", JSON_ARRAY);
assertEquals("NULL", transformedResponse);
}

Expand Down