Add json schema for events
Issue-ID: CPS-348
Issue-ID: CPS-373
Change-Id: Ia0d31f6393e90cb0d5370ca6a78dfbe8817545ae
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
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 0000000..de445ec
--- /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 0000000..f72ecee
--- /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 0000000..de46b71
--- /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