From 5175ddc0991f9bcf594394f9abbc85fdbca3cb9f Mon Sep 17 00:00:00 2001 From: Fiete Ostkamp Date: Wed, 12 Oct 2022 13:50:21 +0000 Subject: Project build error due to reporting configuration not being in reporting section in pom - move the reporting configuration into the reporting block - use https for plugin repository urls - improve the README Issue-ID: AAI-3548 Signed-off-by: Fiete Ostkamp Change-Id: Ic473e8a3942481a987143e2dc9fba02fdcfbc4eb --- .gitignore | 4 ++- README.md | 21 +++++++++++++++ aai-annotations/.classpath | 18 +++++++++++++ aai-annotations/pom.xml | 4 +-- aai-core/pom.xml | 4 +-- aai-schema-ingest/.classpath | 16 +++++++++++- aai-schema-ingest/pom.xml | 4 +-- pom.xml | 61 ++++++++++++++++++++------------------------ readme.md | 23 ----------------- 9 files changed, 90 insertions(+), 65 deletions(-) create mode 100644 README.md delete mode 100644 readme.md diff --git a/.gitignore b/.gitignore index 38cb855c..baf29672 100644 --- a/.gitignore +++ b/.gitignore @@ -12,5 +12,7 @@ bundleconfig-local/etc/logback.xml */.idea *.iml .idea/ +.vscode/ +.devcontainer/ *.log -aai-core/logs/ +aai-core/logs/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..ccb528c5 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# AAI-Common + +## Introduction +`AAI-Common` is a collection of common utility modules used by the other AAI components (`AAI-Resources` and `AAI-Traversal`). These utilities include `aai-schema`, which contains the schema oxm and xsd files; `aai-annotations`, which enables the annotations on the schema files; and `aai-core`, which includes various java packages used by all AAI microservices. `AAI-Resources` and `AAI-Traversal` are already configured to pull these dependencies using maven. For more information on `AAI-Resources` and `AAI-Traversal`, please see the `README.md` files in their respective repositories. This readme only covers AAI-Common. + +## Compiling AAI-Common +Each module of AAI-Common can be compiled using +``` bash +mvn clean install -DskipTests +``` +To compile all of them at once, run this command at the top level of `aai-common`; to do so for a specific module, run it in that module's subdirectory. Integration tests are started by omitting the skipTests flag `mvn clean install`. Again, this can be done for all the submodules at once or for any one individually. + +## Logging +EELF framework is used for **specific logs** (audit, metric and error logs). They are tracking inter component logs (request and response) and allow to follow a complete flow through the AAI subsystem + +Each microservice (AAI-Resources and AAI-Traversal) keeps its own logging directories. Please see their specific readmes for more information. + +## Testing AAI-Common Functionalities +There are JUnit tests for aai-core and aai-annotations. Changes to the schema must be tested in the context of the AAI-Resources microservice via the REST interface. Please see the AAI-Resources readme for details on how to test via the REST API. + + diff --git a/aai-annotations/.classpath b/aai-annotations/.classpath index af1430be..f0257c5a 100644 --- a/aai-annotations/.classpath +++ b/aai-annotations/.classpath @@ -10,6 +10,7 @@ + @@ -22,5 +23,22 @@ + + + + + + + + + + + + + + + + + diff --git a/aai-annotations/pom.xml b/aai-annotations/pom.xml index 27f708d8..c1ed42c8 100644 --- a/aai-annotations/pom.xml +++ b/aai-annotations/pom.xml @@ -61,12 +61,12 @@ central - http://repo1.maven.org/maven2 + https://repo1.maven.org/maven2 EvoSuite EvoSuite Repository - http://www.evosuite.org/m2 + https://www.evosuite.org/m2 diff --git a/aai-core/pom.xml b/aai-core/pom.xml index d6a4c77b..1cf73a78 100644 --- a/aai-core/pom.xml +++ b/aai-core/pom.xml @@ -411,12 +411,12 @@ limitations under the License. central - http://repo1.maven.org/maven2 + https://repo1.maven.org/maven2 EvoSuite EvoSuite Repository - http://www.evosuite.org/m2 + https://www.evosuite.org/m2 diff --git a/aai-schema-ingest/.classpath b/aai-schema-ingest/.classpath index 0f930ed4..5c8072ec 100644 --- a/aai-schema-ingest/.classpath +++ b/aai-schema-ingest/.classpath @@ -10,11 +10,13 @@ + + @@ -27,9 +29,21 @@ - + + + + + + + + + + + + + diff --git a/aai-schema-ingest/pom.xml b/aai-schema-ingest/pom.xml index ea461059..833091d3 100644 --- a/aai-schema-ingest/pom.xml +++ b/aai-schema-ingest/pom.xml @@ -154,12 +154,12 @@ limitations under the License. central - http://repo1.maven.org/maven2 + https://repo1.maven.org/maven2 EvoSuite EvoSuite Repository - http://www.evosuite.org/m2 + https://www.evosuite.org/m2 diff --git a/pom.xml b/pom.xml index 1697492b..b6898898 100644 --- a/pom.xml +++ b/pom.xml @@ -19,8 +19,8 @@ ============LICENSE_END========================================================= --> - + 4.0.0 org.onap.oparent @@ -36,17 +36,17 @@ Contains all of the common code for resources and traversal repos - aai-parent - aai-rest - aai-schema-ingest - aai-annotations + aai-parent + aai-rest + aai-schema-ingest + aai-annotations aai-aaf-auth - aai-core - aai-auth + aai-core + aai-auth aai-els-onap-logging aai-failover - aai-utils - aai-schema-abstraction + aai-utils + aai-schema-abstraction @@ -154,30 +154,6 @@ org.apache.maven.plugins maven-site-plugin 3.6 - - - - org.apache.maven.plugins - maven-project-info-reports-plugin - 2.4 - - false - false - - - dependencies - - - - org.apache.maven.plugins - maven-javadoc-plugin - 2.8 - - -Xdoclint:none - - - - org.apache.maven.wagon @@ -228,6 +204,23 @@ true + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.4 + + false + false + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.8 + + -Xdoclint:none + + diff --git a/readme.md b/readme.md deleted file mode 100644 index b1a44446..00000000 --- a/readme.md +++ /dev/null @@ -1,23 +0,0 @@ -# OpenECOMP AAI-Common - ---- ---- - -# Introduction - -OpenECOMP AAI-Common is a collection of common utility modules used by the other OpenECOMP AAI components (AAI-Resources and AAI-Traversal). These utilities include aai-schema, which contains the schema oxm and xsd files; aai-annotations, which enables the annotations on the schema files; and aai-core, which includes various java packages used by all AAI microservices. AAI-Resources and AAI-Traversal are already configured to pull these dependencies using maven. For more information on AAI-Resources and AAI-Traversal, please see the readme.md files in their respective repositories. This readme only covers AAI-Common. - -# Compiling AAI-Common - -Each module of AAI-Common can be compiled easily with a `mvn clean install -DskipTests`. To compile all of them at once, run this command at the top level of aai-common; to do so for a specific module, run it in that module's subdirectory. Integration tests are started by omitting the skipTests flag `mvn clean install`. Again, this can be done for all the submodules at once or for any one individually. - -# Logging - -EELF framework is used for **specific logs** (audit, metric and error logs). They are tracking inter component logs (request and response) and allow to follow a complete flow through the AAI subsystem - -Each microservice (AAI-Resources and AAI-Traversal) keeps its own logging directories. Please see their specific readmes for more information. - -# Testing AAI-Common Functionalities -There are JUnit tests for aai-core and aai-annotations. Changes to the schema must be tested in the context of the AAI-Resources microservice via the REST interface. Please see the AAI-Resources readme for details on how to test via the REST API. - - -- cgit 1.2.3-korg