Page Comparison

Table of Contents

Jira Legacy

server	System Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-731

Scope

It should be able to query all cm handles with a given set of public cm handle properties.

Requirements

We want all cm-Handles where both things are true.
If name is empty silently ignore, if value is empty (edge case test?)
Those properties also need to exist.
If query body does not follow supported structure return 400.
Empty query will return all cm-Handles.

A/C:

Demo - with "and" behavior
CI Test - two attributes

Issues/Decisions

...

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"
   }
}

...

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

Image Removed

...

Does

Code Block

language	yml

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

...

Table of Contents

Jira Legacy

server	System Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-731

Scope

...

It should be able to query all cm handles with a given set of public cm handle properties.

Requirements

We want all cm-Handles where both things are true.
If name is empty silently ignore, if value is empty (edge case test?)
Those properties also need to exist.
If query body does not follow supported structure return 400.
Empty query will return all cm-Handles.

A/C:

Demo - with "and" behavior
CI Test - two attributes

Issues/Decisions

...

"Size" : "small" green } }

We have two options currently:

Return List<String>

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

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",

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?

 "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

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

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.

Analysis/Implementation Proposal

High level Jiras:

Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-901
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-902
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-903
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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"
]

Below is a sample yaml for OpenAPI.

...

language	yml
title	Sample OpenAPI yAML
collapse	true

...

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

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

Image Added

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

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.

Analysis/Implementation Proposal

...

High level Jiras:

Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-901
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-902
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-903
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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:
        $ref: 'components.yaml#/components/responses/NotFound'application/json:
      500:    schema:
    $ref: 'components.yaml#/components/responses/InternalServerError'

Testing

Edge Cases

Null name, Value
Empty name, Value
no key value pairs at all

Manual Testing

...

cURL Command

...

Both properties match

(CM Handles Returned that Match)

...

Image Removed

...

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": {
        "Contact": "newemailforstore@bookstore.com"
    }
}'

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

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

...

One property doesn't match

(Nothing Returned)

...

Image Removed

...

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": {
        "Contact": "something else"
    }
}'

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

{
    "publicCmHandleProperties": {
        "Contact": "something else"
    }
}

...

{

    "publicCmHandleProperties": {
        "UnknownProperty": "doesn't matter"
    }
}

...

Empty property name

Return 400

(BAD_REQUEST)

...

Image Removed

...

        $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

...

Edge Cases

Null name, Value
Empty name, Value
no key value pairs at all

Manual Testing

Data

Image Added

URL

http://localhost:8883/ncmp/v1

...

/data/ch/searches

Results

#

Scenario

Request

Response

1

Both properties match

(CM Handles Returned that Match)

{

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

[
"Bookstore1",
"PNFDemo"
]

2

Value doesn't match

(Nothing Returned)

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

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

[ ]

3

Unknown properties given - NO cm handles returned

(Return Empty Response)

{
"publicCmHandleProperties": {
"UnknwnProperty": "

doesn't matter http://localhost:8883/ncmp/v1/data/ch/searches

doesnt matter"
}
}

5

No properties given - all cm handles returned

(that contain public properties)

[ ]

4

Empty property name

Return 400

(BAD_REQUEST)

{

"publicCmHandleProperties": {

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

"": "doesnt matter "
}
}

6

Return 400

(BAD_REQUEST)

Image Removed

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": [
        "Contact", "newemailforstore@bookstore.com"
    ]
}'

5

No properties given - all cm handles returned

(that contain public properties)

{

"publicCmHandleProperties": {
}
}

[
    "Bookstore1",
    "Bookstore2",
    "Bookstore3",
    "PNFDemo"
]

6

Property is empty

(BAD_REQUEST)

{
"publicCmHandleProperties": [
"

Contact

", "newemailforstore@bookstore.com"
]
}

7empty value

[ ]

Future Example (Out-of-scope)

...

Versions Compared

Old Version 45

New Version 46

Key

Scope

Issues/Decisions

Scope

Issues/Decisions

Analysis/Implementation Proposal

Interface Proposal

Analysis/Implementation Proposal

Interface Proposal

Testing

Edge Cases

Manual Testing

Testing

Edge Cases

Manual Testing

Data

URL

Results

Future Example (Out-of-scope)