...
- The clamp project is structured as a single pom.xml (no maven submodule), it builds the Frontend and the Backend docker images, publishes a Jar on nexus and a NPM package that can be used to get the clamp UI react components. The frontend is located in the "ui-react" folder, and build with NPM into an NGINX docker container. The backend is a standalone Springboot JAR created from the src folder.
View file name Clamp-0-Project Structure.mp4 height 250 - The backend uses Springboot and Camel, the code entry points are located in "scheduled beans" (policy controller/Sdc Controller) and defined in Camel routes. All Rest api endpoints are defined in Camel. The backend uses also the "spring profiles" to enable or disable features (like sdc controller, aaf cadi, policy controller, etc ...)
View file name Clamp-Entry points (Camel, Beans, Spring profiles).mp4 height 250 - In the clamp structure, there is a folder extra/bin-for-dev that contains scripts for the developer. They are used to start the mariadb container (preload available), the policy/dcae emulator, the backend from the maven target/JAR (debug port opened) and the frontend from the target/ui-react code (using target folder NodeJS). The main language used between the frontend and backend is JSON, so looking at the Firefox Debugger Networks tab, it's possible to see all the data exchanged and understand the flow and debug the javascript code
View file name Clamp-Start Clamp and debug the UI.mp4 height 250 - The code is entirely monitored in term of coverage (used by Sonar), the single maven module facilitates that Sonar report unification. The frontend uses JEST (with snapshots) to do the unit testing of the javascript. The backend is tested with 2 phases, the maven test phase (Junit) and the maven Integration test phase (Junit with SpringBootTest). The integration test phase is crucial as it tests Clamp against a real mariadb, the emulator, and more recently, the Robotframework tests have been introduced during that phase. There are therefore a good tooling chain to validate Clamp code and improves the coverage. VIDEO TO BE DONE
- The backend code has an SDC controller that is used to deploy the service/resources/blueprints created and distributed in SDC. It uses the SDC Client that uses the DMaap notification. The CsarInstaller class is responsible of deploying those artifacts to the clamp database, it creates some "loop templates" that can be used to create a "loop instance". The policy controller is also present to get periodically all the Tosca files defined in the Policy Engine. Those are available to the user for configuring the control loop instance. VIDEO TO BE DONE
- The Frontend does not require any code for the policy UI presented to the user, instead the frontend uses a library that convert a Json Schema to a nice UI. Therefore the backend has a ToscaToJson Converter that is used to convert all tosca based policies. This converter is built to be modular in a sense that plugins can be added to fetch info in third party systems (like CDS), this mechanism is called Json enrichment. The user is therefore able to see in the UI the data coming from others onap/non onap components. The backend supports also a tosca dictionary mechanism that can do simple enrichment for specific tosca keywords defined in that dictionary. VIDEO TO BE DONE
- The backend has an authentication mechanism that is used for each Rest query, there currently 2 Springboot profiles "modules" that be exclusively enabled, either the "cldsDeaultUser" or the AAF one, that uses CADI filter. When using AAF, the user permission are retrieved from the AAF instance, the user can choose a X509 or "basic authentication" login. The front end obviously forward those info to the backend. The frontend is just a renderer without any logic. VIDEO TO BE DONE
- Clamp auto generates the Swagger JSON from the Camel Rest routes automatically. To export that json created only when the backend is up, we use one of the Integration test to export that json into the docs folder. The clamp pom then defines some plugins to convert that JSon to HTML or PDF. There is currently no documentation around those swagger info, it's just a raw Swagger json.
View file name Clamp-Swagger.mp4 height 250
...