# ONAP SDC
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+
## Introduction
SDC is the ONAP visual modeling and design tool. It creates internal metadata that describes assets used by all ONAP components, both at design time and run time.
-The SDC manages the content of a catalog, and logical assemblies of selected catalog items to completely define how and when VNFs are realized in a target environment.
+The SDC manages the content of a catalog and logical assemblies of selected catalog items to completely define how and when VNFs are realized in a target environment.
A complete virtual assembly of specific catalog items, together with selected workflows and instance configuration data, completely defines how the deployment, activation, and life-cycle management of VNFs are accomplished.
SDC manages four levels of assets:
-* Resource - A fundamental capability, implemented either entirely in software, or as software that interacts with a hardware device.
-Each Resource is a combination of one or more Virtual Function Components (VFCs), along with all the information necessary to instantiate, update, delete, and manage the Resource.
-* Service - A well formed object comprising one or more Resources. Service Designers create Services from Resources, and include all of the information about the Service needed to instantiate, update, delete, and manage the Service
+* Resource - A fundamental capability, implemented either entirely in software, or as software that interacts with a hardware device.
+Each Resource is a combination of one or more Virtual Function Components (VFCs), along with all the information necessary to instantiate, update, delete and manage the Resource.
+* Service - A well-formed object comprising one or more Resources. Service Designers create Services from Resources, and include all of the information about the Service needed to instantiate, update, delete and manage the Service.
The key output of SDC is a set of models containing descriptions of asset capabilities and instructions to manage them. These models are stored in the SDC Master Reference Catalog for the entire enterprise to use.
There are four major components of SDC:
* Catalog - The repository for assets at the Resource, Service and Product levels. Assets are added to the Catalog using the Design Studio.
-* Design Studio - Used to create, modify, and add Resource, Service, and Product definitions in the Catalog.
+* Design Studio - Used to create, modify and add Resource, Service and Product definitions in the Catalog.
* Certification Studio - Available in a future release, is used to test new assets at all levels. It will be used for sandbox experimentation, and will include support for automated testing.
* Distribution Studio - Used to deploy certified assets. From the Distribution studio, new Product assets, including their underlying Resources and Services, are deployed into lab environments for testing purposes, and into production after certification is complete. In a future release, there will be a way to export Product information to external Business Support Systems for customer ordering and billing.
## Git Configuration
-Before cloning the sdc source code it's important to enable long paths on your windows machine, otherwise git won't be able to handle with some files
+Note that if you're working on Windows, it's important to enable long paths for your machine; otherwise git won't be able to handle some files.
In order to do so just add this section to your global git.config file under the `[core]` key:
## Compiling the Project
-SDC is built from several projects, while "sdc-main" contains the main pom.xml for all project:
-- asdctool - set of utilities used for scheme creation and data migration in SDC
+SDC is built from several projects while the parent "sdc" contains the main pom.xml for all of them:
+- asdctool - set of utilities used for scheme creation and data migration in SDC
- catalog-be - backend code
- catalog-fe - frontend java code (servlet, proxy)
- catalog-dao - database layer
- catalog-model - data model of the application
- catalog-ui - front end code (javascript, html, css)
-- common - set of utilities used by the onboarding project
+- common - set of utilities used by the onboarding project
- common-app-api - common code for frontend and backend
-- common-be - utilities, datatypes and enums
+- common-be - utilities, datatypes and enums
- security-utils - handle encryption/decryption of passwords
-- onboarding-be - onboarding backend code
-- onboarding-ui - onboarding frontend code
-- test-apis-ci - the automation framework used by SDC for API based testing
-- ui-ci - the automation framework used by SDC for UI based testing, Based on selenium
-- sdc-os-chef - chefs scripts used for docker creation and startup
-- utils - set of dev utils used for working with the project locally
+- onboarding-be - onboarding backend code
+- onboarding-ui - onboarding frontend code
+- integration-tests - The integration tests using the docker images to validate Backend API calls and FE with Selenium
+- sdc-os-chef - chefs scripts used for docker creation and startup
+- utils - set of dev utils used for working with the project locally
+
-In order to build all the projects, go to sdc-main project and run the command: `mvn clean install`
+In order to build all the projects, as mentioned in the onap wiki https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment, the settings.xml (https://git.onap.org/oparent/plain/settings.xml) from the oparent project must be installed in your ~/.m2 folder and referenced by your IDE.
+Once maven is set up properly, go to sdc project and run the command: `mvn clean install`
-Currently SDC build process also supports docker building.
-In order to build and upload local dockers to a local environment you'll need to define an environment variable on your machine with key: `DOCKER_HOST` and value: `tcp://<ip_address>:2375`
-For the dockers to be built during the build process use the "docker" profile by adding this: `-P docker` to the `mvn clean install` command
+By default, the "all" maven profile will be executed but others exist:
+* fast-build - A fast build skipping all tests and useless maven plugins (only builds the jars)
+* start-sdc - Once docker containers have been build, triggering this profile starts SDC CS, BE, FE, simulator
+* stop-sdc - Stop all SDC containers started by using the profile "start-sdc"
+* run-integration-tests - This runs only the integration tests against a running SDC started by using "start-sdc" profile.
+* docker - This enables the docker images build for each SDC module
+ **Note: If you're working on Windows, you'll need to define an environment variable on your machine with key `DOCKER_HOST` and value: `tcp://<ip_address>:2375` in order to build and upload local dockers to a local environment.**
More flags to use in the build process are:
-* -DskipTests - Skips unit tests execution
-* -DskipUICleanup=true - Skips deleting the UI folders
+* -DskipITs - Skips integration tests only
+* -DskipTests - Skips unit tests execution and integration tests
+* -DskipUICleanup=true - Skips deleting the UI folders
* -Djacoco.skip=true - Skips running jacoco tests
* -DskipPMD - Skips creating a PMD report
-**using those flags will speed up the building process of the project**
-
## Accessing SDC
-In order to access the sdc from you're local vagrant environment you'll need to run the webseal_simulator docker.
-This can be achieved by using the command: `/data/scripts/simulator_docker_run.sh`
+After having started SDC with the command `mvn clean install -P start-sdc`, you can access it by accessing this URL: `http://<ip_address>:8285/login`
-to Access the simulator just go to this url: `http://<ip_address>:8285/login`
+[Swagger UI](http://localhost:8080/swagger-ui/index.html) lists some endpoints available from catalog-BE. `http://<IP_ADDRESS>:8080/swagger-ui/index.html`
-For more information regarding using the webseal_simulator please refer to the following guide: [SDC Simulator](https://wiki.onap.org/display/DW/SDC+Simulator)
+As ONAP AAF is not present, the url provided uses the 8285 simulator ports, just click on the user you want to use for accessing SDC (i.e. Carlos Santana)
-## Accessing SDC UI in Dev Mode
-
-In order ro access the SDC UI from your dev environment you need to couple of things:
-
-1. First got to the file `webpack.server.js` found under the catalog-ui folder in the main sdc project and update the "localhost" variable to be the ip of your local vagrant machine.
-2. Now navigate to the catalog-ui folder and run the command: `npm start -- --env.role <wanted_role>` with stating the wanted role to login to SDC as.
+For more information regarding using the webseal_simulator please refer to the following guide: [SDC Simulator](https://wiki.onap.org/display/DW/SDC+Simulator)
-## SDC Containers
+### SDC Containers
-The following table shows the SDC containers found on the vagrant after a successful build:
+The following table shows the SDC containers found after a maven "start-sdc":
-| Name | Description |
-|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
-| sdc-cs | The Docker contains our Cassandra server. On docker startup the Cassandra server is started. |
-| sdc-cs-init | The docker contains the logic for creating the needed schemas for SDC catalog server, On docker startup, the schemes are created. |
-| sdc-cs-onboard-init | The docker contains the logic for creating the needed schemas for SDC onboarding server, On docker startup, the schemes are created. |
-| sdc-es | The Docker contains Elastic Search server. On docker startup, Elastic Search server is started. |
-| sdc-init-es | The Docker contains the logic for creating the needed mapping for SDC and the views for kibana. On docker startup, the mapping is created. |
-| sdc-onboard-BE | The Docker contains the onboarding Backend Jetty server. On docker startup, the Jetty server is started with the application. |
-| sdc-BE | The Docker contains the catalog Backend Jetty server. On docker startup, the Jetty server is started with the application. |
-| sdc-BE-init | The docker contains the logic for importing the SDC Tosca normative types and the logic for configuring external users for SDC external api's.|
-| | on start up, the docker executes the rest calls to the catalog server. |
-| sdc-FE | The Docker contains the SDC Fronted Jetty server. On docker startup, the Jetty server is started with our application. |
+ CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
+ 968a8168e412 onap/sdc-backend-init:latest "/bin/sh -c /home/${…" 9 minutes ago Exited (0) 54 seconds ago sdc-backend-init-1
+ 621c0fda1b0f onap/sdc-backend-all-plugins:latest "sh -c ${JETTY_BASE}…" 9 minutes ago Up 9 minutes 0.0.0.0:4000->4000/tcp, 0.0.0.0:8080->8080/tcp, 0.0.0.0:8443->8443/tcp sdc-backend-all-plugins-1
+ d823078776d8 onap/sdc-onboard-backend:latest "sh -c ${JETTY_BASE}…" 9 minutes ago Up 9 minutes 0.0.0.0:4001->4001/tcp, 0.0.0.0:8081->8081/tcp, 0.0.0.0:8445->8445/tcp, 8080/tcp sdc-onboard-backend-1
+ 4729b0b7f0fe onap/sdc-simulator:latest "sh -c ${JETTY_BASE}…" 9 minutes ago Up 9 minutes 0.0.0.0:8285->8080/tcp, 0.0.0.0:8286->8443/tcp sdc-simulator-1
+ 583e0d7fa300 onap/sdc-onboard-cassandra-init:latest "/home/sdc/startup.sh" 9 minutes ago Exited (0) 9 minutes ago sdc-onboard-cassandra-init-1
+ 92085524f19f onap/sdc-cassandra-init:latest "/home/sdc/startup.sh" 10 minutes ago Exited (0) 9 minutes ago sdc-cassandra-init-1
+ c6e90dd7ddaf selenium/standalone-firefox:2.53.1 "/opt/bin/entry_poin…" 10 minutes ago Up 10 minutes 0.0.0.0:4444->4444/tcp standalone-firefox-1
+ e02139c0379b onap/sdc-frontend:latest "sh -c ${JETTY_BASE}…" 10 minutes ago Up 10 minutes 0.0.0.0:6000->6000/tcp, 0.0.0.0:8181->8181/tcp, 0.0.0.0:9443->9443/tcp, 8080/tcp sdc-frontend-1
+ 96843fae9e4c onap/sdc-cassandra:latest "/root/startup.sh" 10 minutes ago Up 10 minutes 7000-7001/tcp, 7199/tcp, 9160/tcp, 0.0.0.0:9042->9042/tcp sdc-cassandra-1
For further information and an image explaining the containers dependency map please refer to the following page: [SDC Docker Diagram](https://wiki.onap.org/display/DW/SDC+Troubleshooting)
-## Testing the Project
-When building SDC dockers part of the dockers that will be built are the dockers that responsible for running automation tests in the local environment.
-
-In order to run the automation tests when starting the dockers on the machine there are 2 falgs to use:
-
-* -tad - Use this flag to run the default suite of API tests
-* -tud - Use this flag to run the default suite of UI tests
-
-You can go to this link to view all the commands in the vagrant-onap: [Vagrant Common Commands](https://wiki.onap.org/display/DW/SDC+Vagrant+Common+Commands)
-
-And to this guide regarding using the docker run script: [SDC docker_run Script Usage](https://wiki.onap.org/display/DW/SDC+docker_run+Script+Usage)
-
-For more information regarding testing the project please refer to the following guide: [SDC Sanity](https://wiki.onap.org/display/DW/SDC+Sanity)
+### Accessing the logs
+
+To access the logs, there are different options:
+* Connect to the docker container you want to inspect by doing `docker exec -it -u root sdc-XXXXXXXX-1 sh`
+ * Then look at the logs generally in /var/lib/jetty/logs or /var/log/onap (that may differ !)
+* A volume is shared between the BE, onboard-BE and FE containers, this volume is mapped to `/tmp/sdc-integration-tests`,
+ * In that folder you can obtain the logs of the different containers
+
+### Debugging SDC
+
+After having started SDC with the command `mvn clean install -P start-sdc`, different java remote debug ports are opened by default:
+* Onboard Backend - 4001 (jetty)
+* Backend - 4000 (jetty)
+* Frontend - 6000 (jetty)
+It's therefore possible to connect your IDE to those debug ports remotely to walk through the code and add some breakpoints.
+
+**Look at the pom.xml of the integration-tests module to have a better understanding of all the docker settings provided to start SDC.**
+
+### Integration tests
+The integration are composed of 2 parts, one to test the BE Apis and another one to test the FE with selenium.
+
+The selenium tests make use of the selenium/standalone-firefox:2.53.1 container.
+
+About BE APIs tests, onboarding E2E flow :
+Onboarding E2E flow cover following SDC functionality:
+
+ Onboard of VNF
+ Create VF from VSP
+ Certify VF
+ Create Service
+ Add VF to service
+
+ Certify Service
+ Export TOSCA and validate it structure using external TOSCA parser
+
+**as part of execution we open a connection to Titan and perform resources clean up both before and after tests execution (only resource with “ci” prefix will be deleted from the catalog)
+List of VNFs/PNFs that proceed by onboarding flow, located in `integration-tests/src/test/resources/Files/`)
+
+ sample-signed-pnf-cms-includes-cert-1.0.1-SNAPSHOT.zip
+ sample-signed-pnf-1.0.1-SNAPSHOT.zip
+ sample-pnf-1.0.1-SNAPSHOT.csar
+ sample-pnf-custom-type.csar
+ base_vfw.zi
+ base_vvg.zip
+ database-substitution-mappings.csar
+ helm.zip
+ Huawei_vHSS.csar
+ Huawei_vMME.csar
+ infra.zip
+ resource-ZteEpcMmeVf-csar_fix.csar
+ vbng.zip
+ vbrgemu.zip
+ vfw.zip
+ vgmux.zip
+ vgw.zip
+ vLB.zip
+ vLBMS.zip
+ vSBC_update_v03.csar
+ vsp-vgw.csar
+ vvg.zip
+ ZteEpcMmeVf.csar
+
+#### Start the integration tests manually
+
+Those tests execute the following
+There are 2 options to start them:
+* After having started SDC with the command `mvn clean install -P start-sdc`, run the command `mvn clean install -P run-integration-tests`
+* If you want to debug them and run them from your IDE, you must start them from the testNG Suites files, otherwise this won't work.
+ The test suites are located here:
+ * BE: `integration-tests/src/test/resources/ci/testSuites/backend`
+ * FE: `integration-tests/src/test/resources/ci/testSuites/frontend`
+
+#### Integration tests with Helm Validator
+
+Those tests use container built externally in other ONAP repository: [sdc/sdc-helm-validator](https://gerrit.onap.org/r/admin/repos/sdc/sdc-helm-validator)
+
+You can run those tests same as default integration tests by adding additional profile to maven commands:
+`integration-tests-with-helm-validator`
+* To start SDC with Helm Validator run: `mvn clean install -P start-sdc,integration-tests-with-helm-validator`
+* To execute tests that use Helm Validator use: `mvn clean install -P run-integration-tests,integration-tests-with-helm-validator`
+## Accessing SDC UI in Dev Mode (Legacy way)
+
+In order to access the SDC UI from your dev environment you need to do the following:
+
+1. Go to file `webpack.server.js` found under the catalog-ui folder in the main sdc project and update the "localhost" variable to be the ip of your local vagrant machine.
+2. Navigate to the catalog-ui folder and run the command: `npm start -- --env.role <wanted_role>` with the wanted role to login to SDC as.
## SDC on OOM
6. run npm install
7. create a copy of devConfig.defaults.json file and name it devConfig.json (we already configured git to ignore it so it will not be pushed)
8. in that file, populate the fields of the IP addresses of your BE machine you'd like to connect (pay attention, it is a JSON file): For example http://<host>:<port>
-9. after everything was successful, run gulp
-10. after server was up, your favorite UI will wait for you at: http://localhost:9000/sdc1/proxy-designer1#/onboardVendor
+9. after everything is successful, run gulp
+10. after server is up, your favorite UI will wait for you at: http://localhost:9000/sdc1/proxy-designer1#/onboardVendor
### Troubleshooting:
| | | npm config set https-proxy http://genproxy:8080 |
| | | |
| git protocol is blocked | onboarding network | When within onboarding network, you should set globally that when git |
-| and cannot connect | rules for protocols | protocol is used, then it will be replaced with "https" |
+| and cannot connect | rules for protocols | protocol is used, it will be replaced with "https" |
| | | git config --global url."https://".insteadOf git:// |
--------------------------------------------------------------------------------------------------------------------------------------------------------
BE - `curl http://<ip_address>:8080/sdc2/rest/healthCheck`
-Another method to check about problems in SDC in be looking in the log files.
-The log files of the SDC can be found in the `/data/logs` folder
-
-The docker logs are found under the directory `/docker_logs`.
+Another method to check about problems in SDC is to look at the log files.
The jetty(Applicative) are found in the respective folder according to the wanted section
-For Example, the BE logs will found under the directory `/BE`.
+For example, the BE logs will found under the directory `/BE`.
For more information regarding SDC Troubleshooting please refer to the following guide: [SDC Troubleshooting](https://wiki.onap.org/display/DW/SDC+Troubleshooting)
##### [JIRA](http://jira.onap.org)
-##### [WIKI](https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal)
\ No newline at end of file
+##### [WIKI](https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal)
Code Review / sdc.git / blobdiff