Fix 'Changing VFC version wipes List type property values'-bug

[sdc.git] / README.md

diff --git a/README.md b/README.md
index 53f1ad3..03e7301 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,17 @@
 # ONAP SDC
 
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=bugs)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=coverage)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=onap_sdc)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=onap_sdc&metric=code_smells)](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.
@@ -71,7 +83,11 @@ More flags to use in the build process are:
 ## Accessing SDC
 
 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`
+
+[Swagger UI](http://localhost:8080/swagger-ui/index.html) lists some endpoints available from catalog-BE. `http://<IP_ADDRESS>:8080/swagger-ui/index.html`
+
 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)
+
 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
@@ -96,9 +112,9 @@ For further information and an image explaining the containers dependency map pl
 
 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 !)
+    * 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 
+    * In that folder you can obtain the logs of the different containers 
 
 ### Debugging SDC
 
@@ -112,6 +128,7 @@ It's therefore possible to connect your IDE to those debug ports remotely to wal
 
 ### 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 :
@@ -162,7 +179,15 @@ There are 2 options to start them:
   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: