From b220d74e147ebdb86c5416432968bef6de22ca77 Mon Sep 17 00:00:00 2001 From: Rishi Chail Date: Wed, 16 Sep 2020 15:23:53 +0100 Subject: [PATCH] DP: [Spike] Project Structure and basic conf Issue-ID: CCSDK-2749 https: //jira.onap.org/browse/CCSDK-2749 Change-Id: I668f97629a5d514e6b43da67063d1e1bdf8e49da Signed-off-by: Rishi Chail --- cps/.gitignore | 21 +++ cps/Dockerfile | 1 + cps/LICENSE.txt | 176 +++++++++++++++++++++ cps/cps-rest/pom.xml | 77 +++++++++ .../main/java/org/onap/cps/rest/Application.java | 32 ++++ .../org/onap/cps/rest/config/JerseyConfig.java | 37 +++++ .../onap/cps/rest/controller/ModelController.java | 36 +++++ cps/cps-rest/src/main/resources/application.yml | 11 ++ cps/cps-rest/src/main/resources/logback-spring.xml | 48 ++++++ cps/cps-ri/lombok.config | 2 + cps/cps-ri/pom.xml | 31 ++++ .../src/main/java/org/onap/cps/spi/dummy.txt | 1 + cps/cps-ri/src/main/resources/application.yml | 8 + cps/cps-ri/src/main/resources/logback-spring.xml | 48 ++++++ cps/cps-service/pom.xml | 42 +++++ .../src/main/java/org/onap/cps/api/dummy.txt | 1 + .../src/main/java/org/onap/cps/spi/dummy.txt | 1 + .../src/main/resources/logback-spring.xml | 48 ++++++ cps/pom.xml | 115 ++++++++++++++ cps/version.properties | 12 ++ 20 files changed, 748 insertions(+) create mode 100644 cps/.gitignore create mode 100644 cps/Dockerfile create mode 100644 cps/LICENSE.txt create mode 100644 cps/cps-rest/pom.xml create mode 100644 cps/cps-rest/src/main/java/org/onap/cps/rest/Application.java create mode 100644 cps/cps-rest/src/main/java/org/onap/cps/rest/config/JerseyConfig.java create mode 100644 cps/cps-rest/src/main/java/org/onap/cps/rest/controller/ModelController.java create mode 100644 cps/cps-rest/src/main/resources/application.yml create mode 100644 cps/cps-rest/src/main/resources/logback-spring.xml create mode 100644 cps/cps-ri/lombok.config create mode 100644 cps/cps-ri/pom.xml create mode 100644 cps/cps-ri/src/main/java/org/onap/cps/spi/dummy.txt create mode 100644 cps/cps-ri/src/main/resources/application.yml create mode 100644 cps/cps-ri/src/main/resources/logback-spring.xml create mode 100644 cps/cps-service/pom.xml create mode 100644 cps/cps-service/src/main/java/org/onap/cps/api/dummy.txt create mode 100644 cps/cps-service/src/main/java/org/onap/cps/spi/dummy.txt create mode 100644 cps/cps-service/src/main/resources/logback-spring.xml create mode 100644 cps/pom.xml create mode 100644 cps/version.properties diff --git a/cps/.gitignore b/cps/.gitignore new file mode 100644 index 0000000000..ba64fc2fdf --- /dev/null +++ b/cps/.gitignore @@ -0,0 +1,21 @@ +*.class +*.jar +*.war + +target/ +log/ + +.idea/ +.idea_modules/ +*.iml +*.ipr +*.iws + +.settings/ +bin/ +tmp/ +.metadata +.classpath +.project +*.tmp +.checkstyle \ No newline at end of file diff --git a/cps/Dockerfile b/cps/Dockerfile new file mode 100644 index 0000000000..81fdf16d37 --- /dev/null +++ b/cps/Dockerfile @@ -0,0 +1 @@ +FROM openjdk:11-jre-slim \ No newline at end of file diff --git a/cps/LICENSE.txt b/cps/LICENSE.txt new file mode 100644 index 0000000000..2bb9ad240f --- /dev/null +++ b/cps/LICENSE.txt @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/cps/cps-rest/pom.xml b/cps/cps-rest/pom.xml new file mode 100644 index 0000000000..41b5c42f32 --- /dev/null +++ b/cps/cps-rest/pom.xml @@ -0,0 +1,77 @@ + + 4.0.0 + cps-rest + + org.onap.cps + cps + 0.0.1-SNAPSHOT + + + + + + org.onap.cps + cps-service + ${project.version} + + + + org.onap.cps + cps-ri + ${project.version} + + + org.springframework.boot + spring-boot-starter-data-jpa + + + + + + org.springframework.boot + spring-boot-starter-jersey + + + org.springframework.boot + spring-boot-starter-tomcat + + + + + + org.springframework.boot + spring-boot-starter-jetty + + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + ${springboot.version} + + + + repackage + + + + + + + diff --git a/cps/cps-rest/src/main/java/org/onap/cps/rest/Application.java b/cps/cps-rest/src/main/java/org/onap/cps/rest/Application.java new file mode 100644 index 0000000000..3183efc653 --- /dev/null +++ b/cps/cps-rest/src/main/java/org/onap/cps/rest/Application.java @@ -0,0 +1,32 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.rest; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} \ No newline at end of file diff --git a/cps/cps-rest/src/main/java/org/onap/cps/rest/config/JerseyConfig.java b/cps/cps-rest/src/main/java/org/onap/cps/rest/config/JerseyConfig.java new file mode 100644 index 0000000000..a7c4307ab5 --- /dev/null +++ b/cps/cps-rest/src/main/java/org/onap/cps/rest/config/JerseyConfig.java @@ -0,0 +1,37 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.rest.config; + +import javax.annotation.PostConstruct; +import javax.ws.rs.ApplicationPath; +import org.glassfish.jersey.server.ResourceConfig; +import org.onap.cps.rest.controller.ModelController; +import org.springframework.context.annotation.Configuration; + +@Configuration +@ApplicationPath("/api/v1") +public class JerseyConfig extends ResourceConfig { + + @PostConstruct + public void init() { + register(ModelController.class); + } +} \ No newline at end of file diff --git a/cps/cps-rest/src/main/java/org/onap/cps/rest/controller/ModelController.java b/cps/cps-rest/src/main/java/org/onap/cps/rest/controller/ModelController.java new file mode 100644 index 0000000000..e155aa94cb --- /dev/null +++ b/cps/cps-rest/src/main/java/org/onap/cps/rest/controller/ModelController.java @@ -0,0 +1,36 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.rest.controller; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +@Path("/hi") +public class ModelController { + + @GET + @Produces(MediaType.TEXT_PLAIN) + public String sayHello() { + return "Hi"; + } +} diff --git a/cps/cps-rest/src/main/resources/application.yml b/cps/cps-rest/src/main/resources/application.yml new file mode 100644 index 0000000000..ab19fe9aba --- /dev/null +++ b/cps/cps-rest/src/main/resources/application.yml @@ -0,0 +1,11 @@ +server: + port: 8080 + +spring: + main: + banner-mode: "off" + +logging: + level: + org: + springframework: INFO \ No newline at end of file diff --git a/cps/cps-rest/src/main/resources/logback-spring.xml b/cps/cps-rest/src/main/resources/logback-spring.xml new file mode 100644 index 0000000000..fce0aca2c4 --- /dev/null +++ b/cps/cps-rest/src/main/resources/logback-spring.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + ../log/${logName}.log + + ${debugLogName}.%d{yyyy-MM-dd}.%i.log.zip + + ${maxFileSize} + ${maxHistory} + ${totalSizeCap} + + + ${debugPattern} + + + + + 256 + + true + + + + + + + + + + + + \ No newline at end of file diff --git a/cps/cps-ri/lombok.config b/cps/cps-ri/lombok.config new file mode 100644 index 0000000000..a23edb413f --- /dev/null +++ b/cps/cps-ri/lombok.config @@ -0,0 +1,2 @@ +config.stopBubbling = true +lombok.addLombokGeneratedAnnotation = true \ No newline at end of file diff --git a/cps/cps-ri/pom.xml b/cps/cps-ri/pom.xml new file mode 100644 index 0000000000..3d0ccf0af3 --- /dev/null +++ b/cps/cps-ri/pom.xml @@ -0,0 +1,31 @@ + + 4.0.0 + + org.onap.cps + cps + 0.0.1-SNAPSHOT + + cps-ri + + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + + org.springframework.boot + spring-boot-starter-validation + + + + org.projectlombok + lombok + + + + + \ No newline at end of file diff --git a/cps/cps-ri/src/main/java/org/onap/cps/spi/dummy.txt b/cps/cps-ri/src/main/java/org/onap/cps/spi/dummy.txt new file mode 100644 index 0000000000..ff2b9f30c3 --- /dev/null +++ b/cps/cps-ri/src/main/java/org/onap/cps/spi/dummy.txt @@ -0,0 +1 @@ +Have a good day ! \ No newline at end of file diff --git a/cps/cps-ri/src/main/resources/application.yml b/cps/cps-ri/src/main/resources/application.yml new file mode 100644 index 0000000000..fc6883346e --- /dev/null +++ b/cps/cps-ri/src/main/resources/application.yml @@ -0,0 +1,8 @@ +spring: + jpa: + hibernate: + ddl-auto: create + datasource: + url: jdbc:mariadb://${DB_HOST}:3306/${DB_NAME} + username: ${USERNAME} + password: ${PWD} \ No newline at end of file diff --git a/cps/cps-ri/src/main/resources/logback-spring.xml b/cps/cps-ri/src/main/resources/logback-spring.xml new file mode 100644 index 0000000000..fce0aca2c4 --- /dev/null +++ b/cps/cps-ri/src/main/resources/logback-spring.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + ../log/${logName}.log + + ${debugLogName}.%d{yyyy-MM-dd}.%i.log.zip + + ${maxFileSize} + ${maxHistory} + ${totalSizeCap} + + + ${debugPattern} + + + + + 256 + + true + + + + + + + + + + + + \ No newline at end of file diff --git a/cps/cps-service/pom.xml b/cps/cps-service/pom.xml new file mode 100644 index 0000000000..a0bf49767c --- /dev/null +++ b/cps/cps-service/pom.xml @@ -0,0 +1,42 @@ + + 4.0.0 + + org.onap.cps + cps + 0.0.1-SNAPSHOT + + cps-service + + + 5.0.5 + + + + + + org.opendaylight.yangtools + yang-parser-api + ${org.opendaylight.yangtools.version} + + + + org.opendaylight.yangtools + yang-parser-impl + ${org.opendaylight.yangtools.version} + + + + org.opendaylight.yangtools + yang-model-util + ${org.opendaylight.yangtools.version} + + + + org.opendaylight.yangtools + yang-data-codec-xml + ${org.opendaylight.yangtools.version} + + + + + \ No newline at end of file diff --git a/cps/cps-service/src/main/java/org/onap/cps/api/dummy.txt b/cps/cps-service/src/main/java/org/onap/cps/api/dummy.txt new file mode 100644 index 0000000000..ff2b9f30c3 --- /dev/null +++ b/cps/cps-service/src/main/java/org/onap/cps/api/dummy.txt @@ -0,0 +1 @@ +Have a good day ! \ No newline at end of file diff --git a/cps/cps-service/src/main/java/org/onap/cps/spi/dummy.txt b/cps/cps-service/src/main/java/org/onap/cps/spi/dummy.txt new file mode 100644 index 0000000000..ff2b9f30c3 --- /dev/null +++ b/cps/cps-service/src/main/java/org/onap/cps/spi/dummy.txt @@ -0,0 +1 @@ +Have a good day ! \ No newline at end of file diff --git a/cps/cps-service/src/main/resources/logback-spring.xml b/cps/cps-service/src/main/resources/logback-spring.xml new file mode 100644 index 0000000000..fce0aca2c4 --- /dev/null +++ b/cps/cps-service/src/main/resources/logback-spring.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + ../log/${logName}.log + + ${debugLogName}.%d{yyyy-MM-dd}.%i.log.zip + + ${maxFileSize} + ${maxHistory} + ${totalSizeCap} + + + ${debugPattern} + + + + + 256 + + true + + + + + + + + + + + + \ No newline at end of file diff --git a/cps/pom.xml b/cps/pom.xml new file mode 100644 index 0000000000..94ed29c077 --- /dev/null +++ b/cps/pom.xml @@ -0,0 +1,115 @@ + + 4.0.0 + + org.onap.oparent + oparent + 3.1.0 + + org.onap.cps + cps + 0.0.1-SNAPSHOT + pom + cps + ONAP Configuration and Persistency Service + + ONAP - CPS + http://www.onap.org/ + + + + 11 + 2.3.3.RELEASE + 1.6.7 + 3.1.0 + + + + + + org.springframework.boot + spring-boot-dependencies + ${springboot.version} + pom + import + + + + + + + + src/main/resources + true + + + + target/generated-sources/license + + third-party-licenses.txt + + + + + target/generated-resources/licenses + + *.* + + third-party-licenses + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + ${version.java.compiler} + ${version.java.compiler} + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + onap-java-style + + check + + process-sources + + onap-checkstyle/onap-java-style.xml + ${project.build.sourceDirectory} + true + true + true + true + warning + true + + + + + + + org.onap.oparent + checkstyle + ${oparent.version} + compile + + + + + + + + + cps-service + cps-rest + cps-ri + + + \ No newline at end of file diff --git a/cps/version.properties b/cps/version.properties new file mode 100644 index 0000000000..12156a9a64 --- /dev/null +++ b/cps/version.properties @@ -0,0 +1,12 @@ +# Note that these variables cannot be structured (e.g. : version.release or version.snapshot etc... ) +# because they are used in Jenkins, whose plug-in doesn't support this + +major=1 +minor=0 +patch=0 + +base_version=${major}.${minor}.${patch} + +# Release must be completed with git revision # in Jenkins +release_version=${base_version} +snapshot_version=${base_version}-SNAPSHOT -- 2.16.6