Page History

...

Given the public properties below

Issue

Notes

Decision

1

Does request body need to declare "publicCmHandleProperties"?

Do we need to explicitly declare "publicCmHandleProperties"?

Will there be another possible variation to this in the future?

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Colour": "red",
          "Size": "large"
   }
}

Yes

2

Are public properties always stored (in postgress) in the format of "name" : x, "value": y?

(does NOT affect implementation)

In the fragment table there are example that follow this format

Code Block

language	yml

{
	"name": "Colour",
	"value": "red"
},
{
	"name": "Size",
	"value": "large"
}

Yes. But all this is hidden when using CpsPath type query

3

Will there only ever be 1 KV pairs in public properties (in the DB)?

Yes, as each property is stored in a separate list-item Fragment
But all this is hidden when using CpsPath type query

4

Does the order matter?

Does

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Colour" : "green",
          "Size" : "small"
   }
}

==

Code Block

language	yml

{
  "publicCmHandleProperties" : {
          "Size" : "small"
          "Colour" : "green",
     }
}

No
But all this is hidden when using CpsPath type query

5

Should search be case sensitive?

depend on CPSPath functionality - may be case-sensitive

https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html

Yes, that is the currently implement as such CpsPath type query. Given it is mostly machine-to-machine type queries this is good enough and performs better

6

What format should the response take?

We have two options currently:

Return List<String>

Code Block

language	yml

[
    "cmHandle1",
    "cmHandle2",
    ...,
    "cmHandleN"
]

2. Return CM Handle Objects

1. Already defined in CPS
2. <Example Pending>

Contact Tony Finnerty & kieran mccarthy regarding this.
Tony Finnerty Has no opinion on this matter

It has been decided to implement this using a list of cm handles

7

what if we have valid entries and one entry is empty?

We would return all cm handles and others that match would be included in this list anyway.

→ To avoid this should we first check the entries int map for empty entries as further processing is unnecessary in this case.

Discussed with Toine Siebelink and implementation changes are required for handling edges cases. we will handle empty and unknown properties separately.

8

Regarding empty/missing property in request

e.g.

{

    "publicCmHandleProperties": {
        "": "doesnt matter "
    }
}

Do we want to throw an exception if there is an empty property?

Do we silently ignore them and move on?

should we send two lists back... one with matching cm handles and one with those that failed processing?

We will throw a DataValidationException if an entry contains an empty property

9

CPS stores Integers as Strings.

Code Block

language	yml

{
    "cmHandle": "Bookstore6",
    publicCmHandleProperties": {
        "color": 12345
        }
}, {
    "cmHandle": "Bookstore7",
    "publicCmHandleProperties": {
        "color": "12345"
        }
}

When stored in CPS Integers are stored as Strings.

xpathattributes

Analysis/Implementation Proposal

...

High level Jiras:

Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-901
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-902
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-903
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-904

Possible High-Level Implementation Steps:

Match all xpaths using CPS Path Query
Iterate over the list and retrieve all attributes
Iterate over the attributes and collect those instances that match
Return collected list of cm handles

Interface Proposal

#

URI

Design Notes

Comment(s)

1

POST /ncmp/v1/data/ch/searches

Scenario : Request received to return all cm handles matching properties given
Method : POST
URI : {ncmpRoot}/ncmp/v1/data/ch/searches
Header : Content-Type: application/json

Request Body

Code Block

language	yml

{
  "publicCmHandleProperties" : {
     "Colour" : "green",
     "Size" : "small"
   }
}

Response Body Example 1

Code Block

language	yml

[
	"cmHandle1",
	"cmHandle2",
	...,
	"cmHandleN"
]

Below is a sample yaml for OpenAPI.

Code Block

language	yml
title	Sample OpenAPI yAML
collapse	true

executeSearchForMatchingPublicProperties:
  post:
    description: Execute search to get all cm handles for the given public properties
    tags:
      - network-cm-proxy
    summary: Execute cm handle search using
    operationId: executeSearchForMatchingPublicProperties
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'components.yaml#/components/schemas/PublicProperties'
    responses:
      200:
        description: OK
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'
      404:
        $ref: 'components.yaml#/components/responses/NotFound'
      500:
        $ref: 'components.yaml#/components/responses/InternalServerError'

Testing

...

Gerrit Link

https://gerrit.onap.org/r/c/cps/+/127541

Data Used for Testing

#	xpath	attributes
1	/dmi-registry/cm-handles[@id='PNFDemo']/public-properties[@name='Contact2']	{"name": "Contact2", "value": "storeemail2@bookstore.com"}
2	/dmi-registry/cm-handles[@id='PNFDemo']/public-properties[@name='Contact']	{"name": "Contact", "value": "newemailforstore@bookstore.com"}
3	/dmi-registry/cm-handles[@id='

Bookstore6

Bookstore5']/public-properties[@name='color']

{"name": "color", "value": "

12345

won't match"}
4	/dmi-registry/cm-handles[@id='

Bookstore7

Bookstore4']/public-properties[@name='color']

{"name": "color", "value": "

12345

"}

Is this expected behavior?

Analysis/Implementation Proposal

High level Jiras:

Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-901
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-902
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-903
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-904

Possible High-Level Implementation Steps:

Match all xpaths using CPS Path Query
Iterate over the list and retrieve all attributes
Iterate over the attributes and collect those instances that match
Return collected list of cm handles

Interface Proposal

...

Request Body

Code Block

language	yml

{
  "publicCmHandleProperties" : {
     "Colour" : "green",
     "Size" : "small"
   }
}

Response Body Example 1

Code Block

language	yml

[
	"cmHandle1",
	"cmHandle2",
	...,
	"cmHandleN"
]


5	/dmi-registry/cm-handles[@id='Bookstore3']/public-properties[@name='color']	{"name": "color", "value": "red"}
6	/dmi-registry/cm-handles[@id='Bookstore2']/public-properties[@name='Contact']	{"name": "Contact", "value": "newemailforstore2@bookstore.com"}
7	/dmi-registry/cm-handles[@id='Bookstore1']/public-properties[@name='Contact']	{"name": "Contact", "value": "newemailforstore@bookstore.com"}
8	/dmi-registry/cm-handles[@id='Bookstore6']/public-properties[@name='color']	{"name": "color", "value": "12345"}
9	/dmi-registry/cm-handles[@id='Bookstore7']/public-properties[@name='color']	{"name": "color", "value": "12345"}
10	/dmi-registry/cm-handles[@id='Bookstore8']/public-properties[@name='size']	{"name": "size", "value": "large"}
11	/dmi-registry/cm-handles[@id='Bookstore8']/public-properties[@name='color']	{"name": "color", "value": "red"}

...

Code Block

language	yml
title	Sample OpenAPI yAMLCreate CM Handles JSON
collapse	true

executeSearchForMatchingPublicProperties:
  post:{
    description: Execute search to get all cm handles for the given public properties"dmiPlugin": "http://172.24.170.77:8783",
    tags"createdCmHandles": [
      - network-cm-proxy
    summary: Execute cm{
 handle search using
    operationId: executeSearchForMatchingPublicProperties
    requestBody:
 "cmHandle": "Bookstore1",
     required: true
      content"publicCmHandleProperties": {
        application/json:
        "Contact": "newemailforstore@bookstore.com"
  schema:
          }
  $ref: 'components.yaml#/components/schemas/PublicProperties'
      responses:},
       200:
 {
            description"cmHandle": OK
"Bookstore2",
            content"publicCmHandleProperties": {
          application/json:
      "Contact": "newemailforstore2@bookstore.com"
     schema:
       }
       type: array},
        {
         items:
   "cmHandle": "Bookstore3",
            type"publicCmHandleProperties": string{
        400:
        $ref: 'components.yaml#/components/responses/BadRequest'"color": "red"
      401:
       }
 $ref: 'components.yaml#/components/responses/Unauthorized'
      403:},
        $ref: 'components.yaml#/components/responses/Forbidden'{
      404:
        $ref: 'components.yaml#/components/responses/NotFound'
  "cmHandle": "Bookstore4",
    500:
        $ref: 'components.yaml#/components/responses/InternalServerError'

Testing

Gerrit Link

https://gerrit.onap.org/r/c/cps/+/127541

Data Used for Testing

...

Code Block

language	yml
title	Create CM Handles JSON
collapse	true

{
    "dmiPlugin": "http://172.24.170.77:8783",
    "createdCmHandles": ["publicCmHandleProperties": {
                "color": ""
            }
        },
        {
            "cmHandle": "Bookstore5",
            "publicCmHandleProperties": {
                "color": "won't match"
            }
        },
        {
            "cmHandle": "Bookstore6",
            "publicCmHandleProperties": {
                "color": 12345
            }
        },
        {
            "cmHandle": "Bookstore7",
            "publicCmHandleProperties": {
                "color": "12345"
            }
        },
        {
            "cmHandle": "Bookstore1Bookstore8",
            "publicCmHandleProperties": {
                "Contactcolor": "newemailforstore@bookstore.comred",
                 }
"size": "large"
            },
        {}
    ]
}              "cmHandle": "Bookstore2",
            "publicCmHandleProperties": {
                "Contact": "newemailforstore2@bookstore.com"
            }
        },
        {
            "cmHandle": "Bookstore3",
            "publicCmHandleProperties": {
                "color": "red"
            }
        },
        {
            "cmHandle": "Bookstore4",
            "publicCmHandleProperties": {
                "color": ""
            }
        },
        {
            "cmHandle": "Bookstore5",
            "publicCmHandleProperties": {
                "color": "won't match"
            }
        }
    ]
}

URL Used for all Requessts

http://localhost:8883/ncmp/v1/data/ch/searches

Results - Happy Path

URL Used for all Requessts

http://localhost:8883/ncmp/v1/data/ch/searches

Results - Happy Path

#

Scenario

Request

Response

Notes/Decisions

1

Both properties match

(Return CM Handles that Match)

{
    "publicCmHandleProperties": {
        "Contact": "newemailforstore@bookstore.com"
    }
}

[
"Bookstore1",
"PNFDemo"
]

2

Multiple Entries - both properties match

(Return CM Handles that Match)

{
    "publicCmHandleProperties": {
        "color" : "red",
        "size" : "large"
    }
}

[
"Bookstore8"
]

3

No properties given

(Return All CM Handles which contain public properties)

{

"publicCmHandleProperties": {
}
}

[
    "Bookstore4",
    "Bookstore5",
    "Bookstore6",
    "Bookstore7",
    "Bookstore1",
    "Bookstore2",
    "Bookstore3",
    "PNFDemo",
    "Bookstore8"
]

Results - Edge Cases

#

Scenario

Request

Response

Notes/Decisions

1

Value doesn't match

(Return Empty Response)

{
    "publicCmHandleProperties": {
        "Contact": "wont match"
    }
}

[ ]

2

Unknown properties given

(Return Empty Response)

{
    "publicCmHandleProperties": {
        "UnknwnProperty": "doesnt matter"
    }
}

[ ]

3

Empty value (valid)

(Return CM Handles Returned

#ScenarioRequestResponse1

Both properties match

(Return CM Handles

that Match)

{

"publicCmHandleProperties": {
"

Contact

color": "

newemailforstore@bookstore.com

"
}
}

[
"

Bookstore1

Bookstore4"

,

"PNFDemo"

]

2

4

Empty property (invalid)

(BAD_REQUEST)

Multiple Entries - both properties match

(Return CM Handles that Match)

{

"publicCmHandleProperties

": {
"Contact

":

"newemailforstore@bookstore.com",

{
"

color

"

: "

red

doesnt matter "
}
}

[

{
"

Bookstore1

status": "400 BAD_REQUEST",

"Bookstore3

"message": "Invalid data.",
"

PNFDemo

details": "Missing public property name - please supply a valid name."

]

}

3

5

Multiple entries with one empty property (invalid)

(BAD_REQUEST)

No properties given

(Return All CM Handles which contain public properties)

{
"publicCmHandleProperties": {
"color" :

}
}[

"

Bookstore4"Bookstore5

",

"" : "doesnt matter",

"Bookstore1",

"Contact": "newemailforstore@bookstore.com"
}
}

{
"status": "400 BAD_REQUEST

"Bookstore2

",

"Bookstore3

"message": "Invalid data.",
"details"

PNFDemo"
]

Results - Edge Cases

: "Missing public property name - please supply a valid name."
}

6

7

Apostrophe in cm handle

(Exception)

*** CPS can create a cm handle with a public property value that has an apostrophe but throws exception when queried ***

#ScenarioRequestResponse1

Value doesn't match

(Return Empty Response)

{
"publicCmHandleProperties": {
"

Contact

color" : "

wont match

won't match"
}
}

[ ]2

Unknown properties given

(Return Empty Response)

{
"

publicCmHandleProperties": {
"UnknwnProperty": "doesnt matter"
}
}[ ]3

Empty value (valid)

(Return CM Handles Returned that Match)

{

    "publicCmHandleProperties": {
        "color": ""
    }
}

[
"Bookstore4"
]

4

Empty property (invalid)

(BAD_REQUEST)

{

    "publicCmHandleProperties": {
        "": "doesnt matter "
    }
}

{
    "status": "400 BAD_REQUEST",
    "message": "Invalid data",
    "details": "Missing property - please supply a valid property"
}

5

Multiple entries with one empty property (invalid)

(BAD_REQUEST)

{
    "publicCmHandleProperties": {
        "color" : "",
        "" : "doesnt matter",
        "Contact": "newemailforstore@bookstore.com"
    }
}

{
    "status": "400 BAD_REQUEST",
    "message": "Invalid data",
    "details": "Missing property - please supply a valid property"
}

6

status": "500 INTERNAL_SERVER_ERROR",
"message": "Error while parsing cpsPath expression",
"details": "failed to parse at line 1 due to extraneous input 't' expecting {']', 'and'}"
}

Will handle this as and when it arises

8

CPS stores Integers as Strings.

Given the public properties below

Code Block

language	yml

{
    "cmHandle": "Bookstore6",
    publicCmHandleProperties": {
        "color": 12345
        }
}, {
    "cmHandle": "Bookstore7",
    "publicCmHandleProperties": {
        "color": "12345"
        }
}

When stored in CPS Integers are stored as Strings.

xpath	attributes
/dmi-registry/cm-handles[@id='Bookstore6']/public-properties[@name='color']	{"name": "color", "value": "12345"}
/dmi-registry/cm-handles[@id='Bookstore7']/public-properties[@name='color']	{"name": "color", "value": "12345"}

Therefore the two requests below return both cm handles regardless of wanting Integer or String.

Apostrophe in cm handle

(Exception)

*** CPS can create a cm handle with a public property value that has an apostrophe but throws exception when queried ***

{
"publicCmHandleProperties": {
"color" : "

won't match

12345"
}
}

{
"

status

publicCmHandleProperties":

"500 INTERNAL_SERVER_ERROR",
"message

{
"color" :

"Error while parsing cpsPath expression

12345
}
}

[
"Bookstore6",
"

details": "failed to parse at line 1 due to extraneous input 't' expecting {']', 'and'}"
}

Bookstore7"
]

Future Example (Out-of-scope)

...

Space shortcuts

Page tree

Versions Compared

Old Version 72

New Version Current

Key

Analysis/Implementation Proposal

Interface Proposal

Testing

Gerrit Link

Data Used for Testing

Analysis/Implementation Proposal

Interface Proposal

Testing

Gerrit Link

Data Used for Testing

Results - Happy Path

Results - Happy Path

Results - Edge Cases

Results - Edge Cases

Future Example (Out-of-scope)