{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Table of Contents","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"bdfc95e1-1b12-4cf5-a327-ffeaf1555ca3"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":2},"content":[{"type":"hardBreak"},{"text":"Background","type":"text"}]},{"type":"paragraph","content":[{"text":"xNF vendors are obliged to provide a number of artifacts, which are used in the operations of the xNFs.","type":"text"},{"type":"hardBreak"},{"text":"Nokia supports mainly the FM and PM use-case artifacts:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VES_Event_Registration (registers all VES events - including alarms/faults)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PM Dictionary (registers all PM counters/measurements)","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"In order to simplify the management of those artifacts, the following steps are proposed:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"We need an artifact browser - able to parse VES_EVENT_REGISTRATION, and PM_Dictionary, which shows the contents in a tabular fashion.","type":"text"},{"type":"hardBreak"},{"text":"The browser shall allow to real-time filter the rows, based on the \"startsWith\" real-time search","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the second step, we need to expand that browser","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"By integrating it with DCAE-DS (beyond the SDC scope)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"By adding a possibility to select an event and use it in CL configuration, with DCAE-DS","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"General description of GAB library","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"GABController is a tool for searching inside the [Yaml](","type":"text"},{"text":"https://yaml.org/","type":"text","marks":[{"type":"link","attrs":{"href":"https://yaml.org/"}}]},{"text":") file content. At this moment is completely independent from any ONAPs component and can be used in any case where searching full json-path format keywords is needed. To use it, two things are required from the user: yaml document and list of fields to filter the results and nothing more.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Usage","type":"text"}]},{"type":"paragraph","content":[{"text":"GABController is provided as a standard JAVA archive and can be imported in any application by adding its JAR name into the classpath or using maven dependency management:","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\t\n org.onap.sdc.common\n onap-generic-artifact-browser-service\n ${project.version}\n compile\n\t","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"The most usable class is GABServiceImpl implements GABService and expose single method for searching paths inside the [Yaml](","type":"text"},{"text":"https://yaml.org/","type":"text","marks":[{"type":"link","attrs":{"href":"https://yaml.org/"}}]},{"text":") file.","type":"text"}]},{"type":"paragraph","content":[{"text":"GABService operates on 2 different types: GABQuery as an input and GABResults as an output model.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example 1 - searching for multiple keywords","type":"text"}]},{"type":"codeBlock","content":[{"text":"/* First You need to create GABService */\nGABService gabService = new GABServiceImpl();\n/* Next step is to prepare your query model.\n* In this example we will use file: \n* '/root/test.yml' \n* and will search for keywords: \n* 'event.structure.commonEventHeader' and 'event.presence' \n*/\nGABQuery gabQuery = new GABQuery(Arrays.asList(\n\"event.structure.commonEventHeader\",\"event.presence\"), \"/root/test.yml\", GABQueryType.PATH);\n/* And at last ask for the results */\nGABResults gabResults = gabService.searchFor(gabQuery);\n/* And thats it. Please notice that IOException can be thrown in some cases.\n* For more info please follow specification inside the JavaDocs. \n*/ ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Dependencies","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Runtime","type":"text"}]},{"type":"paragraph","content":[{"text":"- lombok: 1.16.16 - [Doc](","type":"text"},{"text":"https://projectlombok.org/features/all","type":"text","marks":[{"type":"link","attrs":{"href":"https://projectlombok.org/features/all"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- snakeyaml: 1.21 - [Doc](","type":"text"},{"text":"https://bitbucket.org/asomov/snakeyaml","type":"text","marks":[{"type":"link","attrs":{"href":"https://bitbucket.org/asomov/snakeyaml"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- gson: 2.8.5 - [Doc](","type":"text"},{"text":"https://github.com/google/gson","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/google/gson"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- jsurfer: 1.4.3 - [Doc](","type":"text"},{"text":"https://github.com/jsurfer/JsonSurfer","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/jsurfer/JsonSurfer"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- guava: 18.0 - [Doc](","type":"text"},{"text":"https://github.com/google/guava/wiki/Release18","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/google/guava/wiki/Release18"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- commons-io: 2.6 - [Doc](","type":"text"},{"text":"https://commons.apache.org/proper/commons-io/","type":"text","marks":[{"type":"link","attrs":{"href":"https://commons.apache.org/proper/commons-io/"}}]},{"text":")","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Testing","type":"text"}]},{"type":"paragraph","content":[{"text":"- junit: 5.4.0 - [Doc](","type":"text"},{"text":"https://junit.org/junit5/docs/current/api/","type":"text","marks":[{"type":"link","attrs":{"href":"https://junit.org/junit5/docs/current/api/"}}]},{"text":")","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Tests structure","type":"text"}]},{"type":"paragraph","content":[{"text":"Generic Artifact Browser has got two independent layers of tests:","type":"text"},{"type":"hardBreak"},{"text":"1. Unit testing using JUnit 5 (integrated in every component)","type":"text"},{"type":"hardBreak"},{"text":"2. Component testing using Cucumber 2.3 (component-tests module) ","type":"text"}]},{"type":"paragraph","content":[{"text":"All layers are currently executed during the maven build of the main project.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Dependencies","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Util","type":"text"}]},{"type":"paragraph","content":[{"text":"- guava: 18.0 - [Doc](","type":"text"},{"text":"https://github.com/google/guava/wiki/Release18","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/google/guava/wiki/Release18"}}]},{"text":")","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Testing","type":"text"}]},{"type":"paragraph","content":[{"text":"- junit: 5.4.0 - [Doc](","type":"text"},{"text":"https://junit.org/junit5/docs/current/api/","type":"text","marks":[{"type":"link","attrs":{"href":"https://junit.org/junit5/docs/current/api/"}}]},{"text":")","type":"text"},{"type":"hardBreak"},{"text":"- cucumber: 2.3.1 - [Doc](","type":"text"},{"text":"https://docs.cucumber.io/","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.cucumber.io/"}}]},{"text":")","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"SDC BE integration","type":"text"}]},{"type":"paragraph","content":[{"text":"GAB is prepared as an independent library used for simple searching inside the yaml-file content. SDC exposes dedicated endpoint providing GABs base functionality over ONAP internal artifacts-data. Below you can find screenshot from the SDC swagger page, describing the SDC endpoint for searching for a json paths inside the yaml file","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":45.0},"content":[{"type":"media","attrs":{"width":991,"id":"7dd2e5d4-166f-488c-8515-faaeac362e74","collection":"contentId-16363171","type":"file","height":680}}]},{"type":"paragraph","content":[{"text":"ParentId and artifactUniqueId properties are needed to download artifact data from the Cassandra DAO. Content of the artifact is scanned for wanted fields and parsed to JSON response - friendly for UI representations:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n\t\"data\": [{\n\t\t\t\"path1\": \"value1\",\n\t\t\t\"path2\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"path1\": \"value3\",\n\t\t\t\"path2\": \"value4\"\n\t\t}\n\t]\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"SDC FE integration","type":"text"}]},{"type":"paragraph","content":[{"text":"SDC's VF screen of Deployment Artifacts is extended to show also a ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"button in shape of magnifier icon. Currently ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"magnifier","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"-button should be available for limited kinds of artifacts (for Dublin release only VES_EVENTS artifacts, for Frankfurt VES_EVENTS and PM_DICTIONARY are supported).","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":100.0},"content":[{"type":"media","attrs":{"width":1872,"id":"39c4990e-242c-40b0-ae58-f8395c364b53","collection":"contentId-16363171","type":"file","height":315}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"On a magnifier-button click, a dialog with populated data should appear. It is important to know that even GAB back-end services provides possibility to ask for whatever-fields with only one restriction about correct format (json paths) - for current release only few predefined columns are considered to be shown by the GUI dialog - for VES_EVENTS: event.action[2], event.comment and event.faultFields.alarmAdditionalInformation.keyValuePair[ structure.key.value==faultId].comment; for PM_DICTIONARY: measType, measDescription, measCondition, measResultUnits, measResultRange, measObjClass, measCollectionMethod, measInfoId, iMeasInfoId. Some of these fields can be searched for a substring (all defined for VES_EVENTS and measType, measDescription, measObjClass, measFamily, measInfoId for PM_DICTIONARY). Format of VES_EVENTS and PM_DICTIONARY was discussed and agreed between operators and examples of these artifacts can be found in SDC repository: VES_EVENTS - ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"sdc/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files/fm_metadata_three_fault_defs.yml","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":", PM_DICTIONARY - ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"/sdc/common/onap-generic-artifact-browser/onap-generic-artifact-browser-service/src/test/resources/yaml/pmDictionary.yml","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"text":"Layout of GAB for example VES_EVENTS artifact: ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":27.0},"content":[{"type":"media","attrs":{"width":1920,"id":"b545bcbe-7ba8-4186-8f13-909c0ac68cb4","collection":"contentId-16363171","type":"file","height":1340}}]},{"type":"paragraph","content":[{"text":"Layout of GAB for example PM_DICTIONARY artifact:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":27.0},"content":[{"type":"media","attrs":{"width":1920,"id":"be9b18c7-369f-477a-bf37-a77506406dbc","collection":"contentId-16363171","type":"file","height":1340}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"UI Sanity","type":"text"}]},{"type":"paragraph","content":[{"text":"Both cases are covered by sanity tests available in the repository under the catalog: onap/sdc/ui-ci/src/main/resources/ci/testSuites/gabSanity.xml","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":22.0},"content":[{"type":"media","attrs":{"width":957,"id":"258c229d-9224-4a6a-84db-2d7862e054ea","collection":"contentId-16363171","type":"file","height":838}}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":22.0},"content":[{"type":"media","attrs":{"width":957,"id":"6e939b79-8e10-4549-9496-787c4eec08d3","collection":"contentId-16363171","type":"file","height":837}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"More info","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"5G - FM Meta Data / 5G - PM Dictionary","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16325775"}}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported