diff options
| -rw-r--r-- | cps-events/pom.xml | 76 | ||||
| -rw-r--r-- | cps-events/src/main/resources/schemas/cps-data-updated-event-schema.json | 88 | ||||
| -rw-r--r-- | cps-events/src/test/groovy/org/onap/cps/event/CpsDataUpdatedEventSpec.groovy | 114 | ||||
| -rw-r--r-- | cps-events/src/test/resources/bookstore-chapters.json | 34 | ||||
| -rwxr-xr-x | cps-parent/pom.xml | 35 | ||||
| -rw-r--r-- | pom.xml | 1 | ||||
| -rw-r--r-- | spotbugs/src/main/resources/spotbugs-exclude.xml | 24 |
7 files changed, 362 insertions, 10 deletions
diff --git a/cps-events/pom.xml b/cps-events/pom.xml new file mode 100644 index 0000000000..7c7fec77eb --- /dev/null +++ b/cps-events/pom.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ============LICENSE_START======================================================= + Copyright (c) 2021 Bell Canada. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + ============LICENSE_END========================================================= +--> + +<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="http://maven.apache.org/POM/4.0.0" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.onap.cps</groupId> + <artifactId>cps-parent</artifactId> + <version>1.1.0-SNAPSHOT</version> + <relativePath>../cps-parent/pom.xml</relativePath> + </parent> + + <artifactId>cps-events</artifactId> + <packaging>jar</packaging> + + <dependencies> + <!-- Used by Generated classes for json mapping--> + <dependency> + <groupId>com.fasterxml.jackson.core</groupId> + <artifactId>jackson-databind</artifactId> + </dependency> + <!-- T E S T D E P E N D E N C I E S --> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.spockframework</groupId> + <artifactId>spock-core</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.jsonschema2pojo</groupId> + <artifactId>jsonschema2pojo-maven-plugin</artifactId> + <configuration> + <sourceDirectory>${basedir}/src/main/resources/schemas</sourceDirectory> + <targetPackage>org.onap.cps.event.model</targetPackage> + <generateBuilders>true</generateBuilders> + </configuration> + </plugin> + <plugin> + <groupId>org.jacoco</groupId> + <artifactId>jacoco-maven-plugin</artifactId> + <configuration> + <excludes> + <exclude>org/onap/cps/event/model/*</exclude> + </excludes> + </configuration> + </plugin> + </plugins> + </build> + +</project>
\ No newline at end of file diff --git a/cps-events/src/main/resources/schemas/cps-data-updated-event-schema.json b/cps-events/src/main/resources/schemas/cps-data-updated-event-schema.json new file mode 100644 index 0000000000..de445ec722 --- /dev/null +++ b/cps-events/src/main/resources/schemas/cps-data-updated-event-schema.json @@ -0,0 +1,88 @@ +{ + + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "urn:cps:org.onap.cps:data-updated-event-schema:1.1.0-SNAPSHOT", + + "$ref": "#/definitions/CpsDataUpdatedEvent", + + "definitions": { + + "CpsDataUpdatedEvent": { + "description": "The payload for CPS data updated event.", + "type": "object", + "properties": { + "schema": { + "description": "The schema, including its version, that this event adheres to.", + "type": "string", + "default": "urn:cps:org.onap.cps:data-updated-event-schema:1.1.0-SNAPSHOT", + "enum": ["urn:cps:org.onap.cps:data-updated-event-schema:1.1.0-SNAPSHOT"] + }, + "id": { + "description": "The unique id identifying the event for the specified source. Producer must ensure that source + id is unique for each distinct event.", + "type": "string" + }, + "source": { + "description": "The source of the event. Producer must ensure that source + id is unique for each distinct event.", + "type": "string", + "format": "uri" + }, + "type": { + "description": "The type of the event.", + "type": "string" + }, + "content": { + "$ref": "#/definitions/Content" + } + }, + "required": [ + "schema", + "id", + "source", + "type", + "content" + ], + "additionalProperties": false + }, + + "Content": { + "description": "The event content.", + "type": "object", + "properties": { + "observedTimestamp": { + "description": "The timestamp when the data has been observed. The expected format is 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'. Ex: '2020-12-01T00:00:00.000+0000' ", + "type": "string" + }, + "dataspaceName": { + "description": "The name of CPS Core dataspace the data belongs to.", + "type": "string" + }, + "schemaSetName": { + "description": "The name of CPS Core schema set the data adheres to.", + "type": "string" + }, + "anchorName": { + "description": "The name of CPS Core anchor the data is attached to.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/Data" + } + }, + "required": [ + "timestamp", + "dataspaceName", + "schemaSetName", + "anchorName", + "data" + ], + "additionalProperties": false + }, + + "Data": { + "description": "Data as json object.", + "type": "object" + } + + } + +}
\ No newline at end of file diff --git a/cps-events/src/test/groovy/org/onap/cps/event/CpsDataUpdatedEventSpec.groovy b/cps-events/src/test/groovy/org/onap/cps/event/CpsDataUpdatedEventSpec.groovy new file mode 100644 index 0000000000..f72eceed1c --- /dev/null +++ b/cps-events/src/test/groovy/org/onap/cps/event/CpsDataUpdatedEventSpec.groovy @@ -0,0 +1,114 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (c) 2021 Bell Canada. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= +*/ + +package org.onap.cps.event + +import com.fasterxml.jackson.databind.ObjectMapper +import com.fasterxml.jackson.databind.node.ObjectNode +import org.onap.cps.event.model.Content +import org.onap.cps.event.model.CpsDataUpdatedEvent +import org.onap.cps.event.model.Data +import spock.lang.Specification + +/** + * Test class for CpsDataUpdatedEvent. + */ +class CpsDataUpdatedEventSpec extends Specification { + + def objectMapper = new ObjectMapper() + + final DATASPACE_NAME = 'my-dataspace' + final BOOKSTORE_SCHEMA_SET = 'bootstore-schemaset' + final ANCHOR_NAME = 'chapters' + final EVENT_TIMESTAMP = '2020-12-01T00:00:00.000+0000' + final EVENT_ID = '77b8f114-4562-4069-8234-6d059ff742ac' + final EVENT_SOURCE = new URI('urn:cps:org.onap.cps') + final EVENT_TYPE = 'org.onap.cps.data-updated-event' + final EVENT_SCHEMA = 'urn:cps:org.onap.cps:data-updated-event-schema:1.1.0-SNAPSHOT' + + final DATA = [ + 'test:bookstore': [ + 'bookstore-name': 'Chapters', + 'categories' : [ + ['code' : '01', + 'name' : 'SciFi', + 'books': [ + ['authors' : ['Iain M. Banks'], + 'lang' : 'en', + 'price' : 895, + 'pub_year': '1994', + 'title' : 'Feersum Endjinn' + ] + ] + ] + ] + ] + ] + + def 'Conversion from JSON String to CpsDataUpdatedEvent POJO.'() { + when: 'event JSON String is converted to CpsDataUpdatedEvent' + def notificationMessage = getEventAsJsonStringFromFile() + def cpsDataUpdatedEvent = objectMapper.readValue(notificationMessage, CpsDataUpdatedEvent.class) + then: 'CpsDataUpdatedEvent POJO has the excepted values' + cpsDataUpdatedEvent.id == EVENT_ID + cpsDataUpdatedEvent.source == EVENT_SOURCE + cpsDataUpdatedEvent.schema.value() == EVENT_SCHEMA + cpsDataUpdatedEvent.type == EVENT_TYPE + def content = cpsDataUpdatedEvent.content + content.observedTimestamp == EVENT_TIMESTAMP + content.dataspaceName == DATASPACE_NAME + content.schemaSetName == BOOKSTORE_SCHEMA_SET + content.anchorName == ANCHOR_NAME + content.data.getAdditionalProperties() == DATA + } + + def 'Conversion CpsDataUpdatedEvent POJO to JSON String.'() { + given: 'Event content with the Data' + def data = new Data() + data.withAdditionalProperty('test:bookstore', DATA.'test:bookstore') + def content = new Content() + content.withAnchorName(ANCHOR_NAME) + .withDataspaceName(DATASPACE_NAME) + .withSchemaSetName(BOOKSTORE_SCHEMA_SET) + .withObservedTimestamp(EVENT_TIMESTAMP) + .withData(data) + and: 'CpsDataUpdatedEvent with the content' + def cpsDataUpdateEvent = new CpsDataUpdatedEvent() + cpsDataUpdateEvent + .withSchema( + CpsDataUpdatedEvent.Schema.fromValue(EVENT_SCHEMA)) + .withId(EVENT_ID) + .withSource(EVENT_SOURCE) + .withType(EVENT_TYPE) + .withContent(content) + when: 'CpsDataUpdatedEvent is converted to JSON string' + def actualMessage = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(cpsDataUpdateEvent) + then: 'the created JSON String is same as the expected JSON String' + def expectedMessage = getEventAsJsonStringFromFile() + assert actualMessage == expectedMessage + } + + def getEventAsJsonStringFromFile() { + return objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString( + objectMapper.readValue( + this.class.getResource('/bookstore-chapters.json').getText('UTF-8'), + ObjectNode.class) + ) + } + +}
\ No newline at end of file diff --git a/cps-events/src/test/resources/bookstore-chapters.json b/cps-events/src/test/resources/bookstore-chapters.json new file mode 100644 index 0000000000..de46b71841 --- /dev/null +++ b/cps-events/src/test/resources/bookstore-chapters.json @@ -0,0 +1,34 @@ +{ + "schema": "urn:cps:org.onap.cps:data-updated-event-schema:1.1.0-SNAPSHOT", + "id": "77b8f114-4562-4069-8234-6d059ff742ac", + "source": "urn:cps:org.onap.cps", + "type": "org.onap.cps.data-updated-event", + "content": { + "observedTimestamp": "2020-12-01T00:00:00.000+0000", + "dataspaceName": "my-dataspace", + "schemaSetName": "bootstore-schemaset", + "anchorName": "chapters", + "data": { + "test:bookstore":{ + "bookstore-name": "Chapters", + "categories": [ + { + "code": "01", + "name": "SciFi", + "books": [ + { + "authors": [ + "Iain M. Banks" + ], + "lang": "en", + "price": 895, + "pub_year": "1994", + "title": "Feersum Endjinn" + } + ] + } + ] + } + } + } +}
\ No newline at end of file diff --git a/cps-parent/pom.xml b/cps-parent/pom.xml index eb71b52e00..78a89f0aca 100755 --- a/cps-parent/pom.xml +++ b/cps-parent/pom.xml @@ -37,21 +37,22 @@ <properties> <app>org.onap.cps.Application</app> + <docker.repository.push>nexus3.onap.org:10003/</docker.repository.push> + <docker.repository.pull>nexus3.onap.org:10001/</docker.repository.pull> <java.version>11</java.version> + <jsonschema2pojo-maven-plugin.version>1.1.1</jsonschema2pojo-maven-plugin.version> <minimum-coverage>0.9</minimum-coverage> <nexusproxy>https://nexus.onap.org</nexusproxy> - <docker.repository.push>nexus3.onap.org:10003/</docker.repository.push> - <docker.repository.pull>nexus3.onap.org:10001/</docker.repository.pull> <oparent.version>3.1.0</oparent.version> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <releaseNexusPath>/content/repositories/releases/</releaseNexusPath> + <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath> <spotbugs-maven-plugin.version>4.1.3</spotbugs-maven-plugin.version> - <spring-boot-maven-plugin.version>2.3.3.RELEASE</spring-boot-maven-plugin.version> <spotbugs.slf4j.version>1.8.0-beta4</spotbugs.slf4j.version> <spotbugs.bug-pattern.version>1.5.0</spotbugs.bug-pattern.version> <spotbugs.version>4.2.0</spotbugs.version> + <spring-boot-maven-plugin.version>2.3.3.RELEASE</spring-boot-maven-plugin.version> <swagger-codegen-maven-plugin.version>3.0.18</swagger-codegen-maven-plugin.version> - <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath> <jacoco.reportDirectory.aggregate>${project.reporting.outputDirectory}/jacoco-aggregate</jacoco.reportDirectory.aggregate> <sonar.coverage.jacoco.xmlReportPaths> @@ -180,6 +181,7 @@ If you run out of memory, changes the value of the effort element to 'Low'. --> + <addSourceDirs>true</addSourceDirs> <effort>Max</effort> <!-- Reports all bugs (other values are medium and max) --> <threshold>Low</threshold> @@ -205,6 +207,21 @@ </execution> </executions> </plugin> + <plugin> + <groupId>org.jsonschema2pojo</groupId> + <artifactId>jsonschema2pojo-maven-plugin</artifactId> + <version>${jsonschema2pojo-maven-plugin.version}</version> + <configuration> + <targetVersion>${java.version}</targetVersion> + </configuration> + <executions> + <execution> + <goals> + <goal>generate</goal> + </goals> + </execution> + </executions> + </plugin> </plugins> </pluginManagement> <plugins> @@ -336,6 +353,12 @@ <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> + <configuration> + <excludes> + <exclude>org/onap/cps/rest/model/*</exclude> + <exclude>org/onap/cps/cpspath/parser/antlr4/*</exclude> + </excludes> + </configuration> <executions> <execution> <id>default-prepare-agent</id> @@ -349,10 +372,6 @@ <goal>check</goal> </goals> <configuration> - <excludes> - <exclude>org/onap/cps/rest/model/*</exclude> - <exclude>org/onap/cps/cpspath/parser/antlr4/*</exclude> - </excludes> <dataFile>${project.build.directory}/code-coverage/jacoco-ut.exec</dataFile> <rules> <rule> @@ -50,6 +50,7 @@ <module>cps-dependencies</module>
<module>cps-bom</module>
<module>cps-parent</module>
+ <module>cps-events</module>
<module>cps-service</module>
<module>cps-rest</module>
<module>cps-ncmp-service</module>
diff --git a/spotbugs/src/main/resources/spotbugs-exclude.xml b/spotbugs/src/main/resources/spotbugs-exclude.xml index 7fdda7364e..059b560691 100644 --- a/spotbugs/src/main/resources/spotbugs-exclude.xml +++ b/spotbugs/src/main/resources/spotbugs-exclude.xml @@ -1,7 +1,26 @@ +<!-- + ============LICENSE_START======================================================= + Copyright (c) 2021 Pantheon.tech. + Modifications Copyright (C) 2021 Bell Canada. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + ============LICENSE_END========================================================= +--> + <FindBugsFilter> <Match> - <!-- Ignore generated code from Antlr4 --> - <Package name="org.onap.cps.cpspath.parser.antlr4" /> + <!-- Ignore generated code --> + <Source name="~.*generated-sources.*.java"/> </Match> <Match> <Or> @@ -28,4 +47,5 @@ <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/> </Or> </Match> + </FindBugsFilter> |