Skip to content

Commit df5908c

Browse files
Sergio Andres Mejia TovarNicolò Bidotti
authored andcommitted
[WIT-2828] Bootstrap Java Tech Adapter Framework
# New features and improvements * Bootstraps the Framework by using the Java Scaffold code * Separates the project into two modules, core and model # Related issue Closes WIT-2828 # Definition of Done So you are going to put your MR in review, but are you sure you have done all things listed here? ## All Developments - [x] **Feature was implemented as per the requirements** - [x] **If some code parts are complex they must be commented with code documentation** - [x] **Unit, integration and E2E tests have been performed and code coverage is not reduced**, so that new code is covered - [x] **CI/CD is successful** - [x] **Exceptions and errors are handled, returning meaningful errors to the user**, without letting the underlying framework to respond with a generic Internal Server Error. Technical details are stored in the errors/problems and not in the user message - [x] **Documentation (user documentation, HLD and others) has been updated** - Documentation has been updated with explanation of the new feature if it's user-facing (e.g. component now has additional setting) or it impacts them in some other way (e.g. optional field that becomes mandatory) - If it is a breaking change, we have documented it as such in the MR description in a "Breaking Changes" section - [ ] **Helm chart and other DevOps artifacts** have been updated and are valid deployment tools for the new version - [x] **Problematic information (sensitive information, credentials, customer information or other intellectual property) is not included in the changes** as they could end up being public (most SPs are already published and automatically mirrored on every merge) - [x] **Feature doesn't negatively affect any existing environments**, especially the clients Playgrounds. This means that merging it to master and deploying it to these environments will not break them and **no manual operations that are not reported in the documentation will be needed** - [x] **If dependencies were changed, be sure that they will not impact the project**, that their license is compatible, and that they introduce no vulnerabilities - [x] **Security, Authentication and Authorization have been considered**. No SQL injection, tokens handling, RBAC integration. Common security vulnerabilities identified and resolved ## API related Development - [x] **API Parameters and return body are compliant** with the API specification - [x] **Errors are correctly handled**, respecting the type of errors return bodies and responses for each endpoint - [x] **API is logging in compliance with audit standards**, presence of sensitive information for GDPR has been assessed and removed or managed in case is needed ## DB related Development - [ ] **The database schema is designed to accurately** represent the data model and meet the requirements - [ ] **Tables, relationships, and constraints (e.g. primary keys, foreign keys, unique constraints) are defined appropriately**, following best practices and a common naming convention - [ ] **Sensitive data is stored securely**, encrypted if required, and access is restricted to authorized users - [ ] **Migration scripts to upgrade and downgrade the database have been implemented and tested**
1 parent 0c5db4a commit df5908c

File tree

61 files changed

+3965
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+3965
-11
lines changed

.gitlab-ci.yml

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
include:
2+
- project: 'AgileFactory/Witboost.Mesh/witboost.Mesh.CI'
3+
ref: 'main'
4+
file: 'common/witboost.helm.gitlab-ci.yml'
5+
- template: Security/SAST.gitlab-ci.yml
6+
- template: Security/Secret-Detection.gitlab-ci.yml
7+
- template: Jobs/Container-Scanning.gitlab-ci.yml
8+
9+
image: maven:3.9.4-eclipse-temurin-17
10+
11+
variables:
12+
MAVEN_CLI_OPTS: "-s ci_settings.xml --batch-mode"
13+
MAVEN_OPTS: "-Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository"
14+
15+
cache:
16+
paths:
17+
- .m2/repository/
18+
19+
stages:
20+
- setup
21+
- compile
22+
- test
23+
- coverage
24+
- package
25+
- publish
26+
27+
setup:
28+
stage: setup
29+
extends: .witboost.helm.base-job
30+
cache: []
31+
before_script: []
32+
script:
33+
- !reference [.witboost.helm.clone-scripts, script]
34+
- !reference [.witboost.helm.get-version, script]
35+
- echo "VERSION=${VERSION}" >> vars.env
36+
- echo "FRAMEWORK_VERSION=${VERSION}" >> vars.env
37+
artifacts:
38+
reports:
39+
dotenv: vars.env
40+
41+
sast:
42+
stage: setup
43+
cache: []
44+
artifacts:
45+
paths:
46+
- gl-sast-report.json
47+
reports:
48+
sast: gl-sast-report.json
49+
50+
secret_detection:
51+
stage: setup
52+
cache: []
53+
artifacts:
54+
paths:
55+
- gl-secret-detection-report.json
56+
reports:
57+
secret_detection: gl-secret-detection-report.json
58+
59+
fail_on_detection:
60+
needs:
61+
- semgrep-sast
62+
- secret_detection
63+
before_script:
64+
- apt update -y && apt -y install jq
65+
script:
66+
- ls -a
67+
- jq '.vulnerabilities[] | .severity' gl-sast-report.json | grep 'High\|Critical' && echo 'Vulnerabilities found in gl-sast-report.json' && exit 1 || true;
68+
- jq '.vulnerabilities[] | .severity' gl-secret-detection-report.json | grep 'High\|Critical' && echo 'Vulnerabilities found in gl-secret-detection-report.json' && exit 1 || true;
69+
- echo 'No serious vulnerabilities found.'
70+
rules:
71+
- if: $CI_COMMIT_BRANCH
72+
exists:
73+
- '**/*.py'
74+
- '**/*.js'
75+
- '**/*.jsx'
76+
- '**/*.ts'
77+
- '**/*.tsx'
78+
- '**/*.c'
79+
- '**/*.go'
80+
- '**/*.java'
81+
- '**/*.cs'
82+
- '**/*.html'
83+
- '**/*.scala'
84+
- '**/*.sc'
85+
86+
vulnerability_analysis:
87+
stage: compile
88+
before_script:
89+
- mvn --version
90+
script:
91+
- mvn -DskipTests=true package org.owasp:dependency-check-maven:check
92+
artifacts:
93+
when: always
94+
paths:
95+
- report/target/dependency-check-report.html
96+
97+
license_check:
98+
stage: compile
99+
before_script:
100+
- mvn --version
101+
script:
102+
- mvn -DskipTests=true package licensescan:audit
103+
artifacts:
104+
when: always
105+
paths:
106+
- common/target/license-scan-results/index.html
107+
- common/target/license-scan-results/license-scan-report.json
108+
109+
linter:
110+
stage: compile
111+
before_script:
112+
- mvn --version
113+
script:
114+
- mvn spotless:check
115+
116+
compile:
117+
stage: compile
118+
script:
119+
- mvn $MAVEN_CLI_OPTS compile
120+
121+
test-jdk17:
122+
stage: test
123+
script:
124+
- mvn $MAVEN_CLI_OPTS org.jacoco:jacoco-maven-plugin:prepare-agent test jacoco:report-aggregate
125+
- cat report/target/site/jacoco-aggregate/index.html | grep -o '<tfoot>.*</tfoot>'
126+
coverage: '/Total.*?([0-9]{1,3})%/'
127+
artifacts:
128+
when: always
129+
paths:
130+
- report/target/site/jacoco-aggregate/jacoco.xml
131+
132+
coverage-jdk17:
133+
stage: test
134+
image: registry.gitlab.com/haynes/jacoco2cobertura:1.0.9
135+
script:
136+
- jacoco_paths=`find * -path "**/src/main/java" -type d | sed -e 's@^@'"$CI_PROJECT_DIR"'/@'`
137+
- python /opt/cover2cover.py report/target/site/jacoco-aggregate/jacoco.xml $jacoco_paths > report/target/site/cobertura.xml
138+
artifacts:
139+
reports:
140+
coverage_report:
141+
coverage_format: cobertura
142+
path: report/target/site/cobertura.xml
143+
needs:
144+
- test-jdk17
145+
146+
package:
147+
stage: package
148+
script:
149+
- mvn -DskipTests=true $MAVEN_CLI_OPTS package
150+
artifacts:
151+
paths:
152+
- common/target/*.jar
153+
154+
publish:
155+
stage: publish
156+
script:
157+
- mvn -DskipTests=true deploy -s ci_settings.xml

.pre-commit-config.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.4.0
4+
hooks:
5+
- id: end-of-file-fixer
6+
- id: trailing-whitespace
7+
- id: check-yaml
8+
args: [ '--unsafe' ]
9+
types: [file, yaml]
10+
11+
- repo: local
12+
hooks:
13+
- id: maven-spotless
14+
name: maven-spotless
15+
entry: mvn spotless:check
16+
language: system
17+
types: [java]
18+
pass_filenames: false

LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)