diff options
| -rw-r--r-- | .gitignore | 4 | ||||
| -rw-r--r-- | README.md | 21 | ||||
| -rw-r--r-- | aai-annotations/pom.xml | 4 | ||||
| -rw-r--r-- | aai-core/pom.xml | 4 | ||||
| -rw-r--r-- | aai-schema-ingest/pom.xml | 4 | ||||
| -rw-r--r-- | pom.xml | 61 | ||||
| -rw-r--r-- | readme.md | 23 |
7 files changed, 57 insertions, 64 deletions
@@ -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/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 @@ <pluginRepositories> <pluginRepository> <id>central</id> - <url>http://repo1.maven.org/maven2</url> + <url>https://repo1.maven.org/maven2</url> </pluginRepository> <pluginRepository> <id>EvoSuite</id> <name>EvoSuite Repository</name> - <url>http://www.evosuite.org/m2</url> + <url>https://www.evosuite.org/m2</url> </pluginRepository> </pluginRepositories> diff --git a/aai-core/pom.xml b/aai-core/pom.xml index 1b91577e..9a990897 100644 --- a/aai-core/pom.xml +++ b/aai-core/pom.xml @@ -401,12 +401,12 @@ limitations under the License. <pluginRepositories> <pluginRepository> <id>central</id> - <url>http://repo1.maven.org/maven2</url> + <url>https://repo1.maven.org/maven2</url> </pluginRepository> <pluginRepository> <id>EvoSuite</id> <name>EvoSuite Repository</name> - <url>http://www.evosuite.org/m2</url> + <url>https://www.evosuite.org/m2</url> </pluginRepository> </pluginRepositories> 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. <pluginRepositories> <pluginRepository> <id>central</id> - <url>http://repo1.maven.org/maven2</url> + <url>https://repo1.maven.org/maven2</url> </pluginRepository> <pluginRepository> <id>EvoSuite</id> <name>EvoSuite Repository</name> - <url>http://www.evosuite.org/m2</url> + <url>https://www.evosuite.org/m2</url> </pluginRepository> </pluginRepositories> @@ -19,8 +19,8 @@ ============LICENSE_END========================================================= --> -<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> +<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.onap.oparent</groupId> @@ -36,17 +36,17 @@ <description>Contains all of the common code for resources and traversal repos</description> <modules> - <module>aai-parent</module> - <module>aai-rest</module> - <module>aai-schema-ingest</module> - <module>aai-annotations</module> + <module>aai-parent</module> + <module>aai-rest</module> + <module>aai-schema-ingest</module> + <module>aai-annotations</module> <module>aai-aaf-auth</module> - <module>aai-core</module> - <module>aai-auth</module> + <module>aai-core</module> + <module>aai-auth</module> <module>aai-els-onap-logging</module> <module>aai-failover</module> - <module>aai-utils</module> - <module>aai-schema-abstraction</module> + <module>aai-utils</module> + <module>aai-schema-abstraction</module> </modules> <profiles> @@ -154,30 +154,6 @@ <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.6</version> - <configuration> - <reportPlugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-project-info-reports-plugin</artifactId> - <version>2.4</version> - <configuration> - <dependencyDetailsEnabled>false</dependencyDetailsEnabled> - <dependencyLocationsEnabled>false</dependencyLocationsEnabled> - </configuration> - <reports> - <report>dependencies</report> - </reports> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.8</version> - <configuration> - <additionalparam>-Xdoclint:none</additionalparam> - </configuration> - </plugin> - </reportPlugins> - </configuration> <dependencies> <dependency> <groupId>org.apache.maven.wagon</groupId> @@ -228,6 +204,23 @@ <useStandardDocletOptions>true</useStandardDocletOptions> </configuration> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.4</version> + <configuration> + <dependencyDetailsEnabled>false</dependencyDetailsEnabled> + <dependencyLocationsEnabled>false</dependencyLocationsEnabled> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.8</version> + <configuration> + <additionalparam>-Xdoclint:none</additionalparam> + </configuration> + </plugin> </plugins> </reporting> 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. - - |