Use default profile and switch country-specific profiles into a feature flag #39

melbeltagy · 2024-07-30T03:55:25Z

Changes:

Splitting each module's code into org.niis.* and fi.dvv.* packages for common and Finland-specific features respectively.
Switch application.properties into yaml format for:
- Clarity in properties structure
- Better support with docker/k8s based environments and usage.
Switching from fi profile to the new xroad-catalog.country.fi.enabled feature flag for both collector and lister modules
Loading Finland-specific features based on the new xroad-catalog.country.fi.enabled feature flag.
Using application.yaml as a common/base configuration file with all default configurations
Using dev profile configuration for local development (to run service from IDE)
Using test profile configuration for tests only
Removing sshtest profile but keeping/updating the documentation
Adding application-fi.sample.yaml and application-production.sample.yaml sample profiles
Using persistence module only for entities and repositories by:
- Splitting services from persistence module into either collector or lister modules
- Persistence module no longer can run as an application
- Persistence module no longer can be used to apply database changes as liquibase is already configured
Grouping properties into different logical groups
Removing unused properties
Adding new configuration section in each module's README.md with all configurations related to the the module

Refs: XRDCAT-8

…ng into common/fi packages) Refs: XRDCAT-8

…splitting into common/fi packages) Refs: XRDCAT-8

…ackage Refs: XRDCAT-8

Refs: XRDCAT-8

…kage Refs: XRDCAT-8

Refs: XRDCAT-8

…package Refs: XRDCAT-8

Refs: XRDCAT-8

…r service) based on usage Refs: XRDCAT-8

…lector service) based on usage Refs: XRDCAT-8

Refs: XRDCAT-8

…vice package Refs: XRDCAT-8

… only Refs: XRDCAT-8

Refs: XRDCAT-8

…plication configs to scan components in both packages Refs: XRDCAT-8

…y broken ones, add application.properties Refs: XRDCAT-8

Refs: XRDCAT-8

github-actions · 2024-07-30T03:56:52Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	❌

…s instead of fi.vrk Refs: XRDCAT-8

Refs: XRDCAT-8

… profile) Refs: XRDCAT-8

… profile) and fi profile Refs: XRDCAT-8

xroad-catalog-lister/README.md

BUILD.md

…ead of fi profile

Refs: XRDCAT-8

github-actions · 2024-08-12T10:19:07Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

Refs: XRDCAT-8

github-actions · 2024-08-13T14:41:14Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

Refs: XRDCAT-8

github-actions · 2024-08-13T14:55:28Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

raits

A few more small things I noticed, but looking pretty good otherwise.

BUILD.md

doc/xroad_catalog_installation_guide.md

xroad-catalog-collector/README.md

xroad-catalog-lister/README.md

Refs: XRDCAT-8

github-actions · 2024-08-14T16:05:10Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

melbeltagy · 2024-08-14T16:13:41Z

@raits , the configurations section in both READMEs for collector and lister services are updated as per your comments (moving reasonably defaulted values to proper optional sections).

And the configurations section in the installation guide is now updated by:

Splitting collector from lister service
Reference READMEs configurations sections (instead of repeating the configurations parameters list)
Added specific instructions for how to enable Finland-specific features (in both services)

And also, added ToC for READMEs and installation guide to help clarifying how the documents are structured

raits

Looks good to me, just a minor comment about the list styles for the new ToC-s.

xroad-catalog-collector/README.md

xroad-catalog-lister/README.md

Refs: XRDCAT-8

github-actions · 2024-08-15T07:31:24Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

Refs: XRDCAT-8

sonarcloud · 2024-08-15T07:39:58Z

Quality Gate passed

Issues
31 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.8% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-08-15T07:41:44Z

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
x-road-catalog	build test	8.7	✅

melbeltagy added 25 commits July 27, 2024 18:22

refactor: Move common entities to org.niis...entity package

5026ee6

Refs: XRDCAT-8

refactor: Move common repositories to org.niis...repository package

7a3489f

Refs: XRDCAT-8

refactor: Move DTOs from persistence module to lister module (splitti…

3ba25f1

…ng into common/fi packages) Refs: XRDCAT-8

refactor: Move services from persistence module to collector module (…

053eb3d

…splitting into common/fi packages) Refs: XRDCAT-8

refactor: Move lister's controllers into own (common/fi) controller p…

0c8af98

…ackage Refs: XRDCAT-8

refactor: Move lister's endpoints into own (common/fi) endpoint package

76b8e45

Refs: XRDCAT-8

refactor: Move lister's services into own (common/fi) service package

b867bf1

Refs: XRDCAT-8

refactor: Move lister's converters into own (common/fi) converter pac…

7fbb455

…kage Refs: XRDCAT-8

refactor: Move lister's interceptors into own common interceptor package

63cabbe

Refs: XRDCAT-8

refactor: Move lister's configurations into own common configuration …

23c1bea

…package Refs: XRDCAT-8

refactor: Move lister's exception into own common exception package

dbc526e

Refs: XRDCAT-8

refactor: Split CatalogService into two (one for each lister/collecto…

e0b8483

…r service) based on usage Refs: XRDCAT-8

refactor: Split CompanyService into two (one for each lister/collecto…

94c1b99

…r service) based on usage Refs: XRDCAT-8

refactor: Split OrganizationService into two (one for each lister/col…

0acc838

…lector service) based on usage Refs: XRDCAT-8

fix: Fix imports after refactorings

bd1b146

Refs: XRDCAT-8

refactor: Move repositories' tests into corresponding (common/fi) ser…

e741346

…vice package Refs: XRDCAT-8

refactor: Remove persistence' Application class and keep it for tests…

7c65983

… only Refs: XRDCAT-8

fix: Add/fix tests initialization by scanning required packages

39b7b46

Refs: XRDCAT-8

chore: Cleanup/remove unused code and SQL files from persistence's tests

8a185f0

Refs: XRDCAT-8

refactor: Split collector's classes into default/vrk packages, add ap…

0d8657d

…plication configs to scan components in both packages Refs: XRDCAT-8

refactor: Split collector's tests into default/vrk packages, fix newl…

509a59b

…y broken ones, add application.properties Refs: XRDCAT-8

refactor: Move main classes to org.niis package

e131ce8

Refs: XRDCAT-8

chore: Remove redundant dependencies

4c96cd5

Refs: XRDCAT-8

refactor: switch to application.properties

df32580

Refs: XRDCAT-8

fix: Fix license

b22ae48

Refs: XRDCAT-8

melbeltagy added 4 commits July 30, 2024 07:26

refactor: Modify generation of classes from WSDL into package org.nii…

fde9ac8

…s instead of fi.vrk Refs: XRDCAT-8

refactor: Move ListerApplication into org.niis package

c9bdbac

Refs: XRDCAT-8

refactor: combine all properties into application.properties (default…

7f396ad

… profile) Refs: XRDCAT-8

refactor: combine all properties into application.properties (default…

a4dade5

… profile) and fi profile Refs: XRDCAT-8

petkivim reviewed Aug 9, 2024

View reviewed changes

xroad-catalog-lister/README.md Outdated Show resolved Hide resolved

petkivim reviewed Aug 9, 2024

View reviewed changes

xroad-catalog-lister/README.md Outdated Show resolved Hide resolved

petkivim reviewed Aug 9, 2024

View reviewed changes

BUILD.md Outdated Show resolved Hide resolved

melbeltagy added 7 commits August 9, 2024 14:15

Merge branch 'refs/heads/develop' into XRDCAT-8-clearer-profiles

2d8c6fa

docs: update docs and comments to reference Finland feature flag inst…

f6923b2

…ead of fi profile

docs: update docs to mention that postgre is the only supported RDBMS

5566596

Refs: XRDCAT-8

chore: fix names

30e87fc

Refs: XRDCAT-8

chore: publish list of new members' code as a set, instead of list

83f40f8

Refs: XRDCAT-8

chore: gitignore any file other than the sample yamls

4e51492

Refs: XRDCAT-8

docs: update parameters paths

2a50dd0

Refs: XRDCAT-8

docs: Update configurations sections in READMEs

087280a

Refs: XRDCAT-8

docs: Update configurations sections in READMEs

dc3ad90

Refs: XRDCAT-8

melbeltagy requested review from petkivim and raits August 13, 2024 14:57

raits requested changes Aug 14, 2024

View reviewed changes

docs: Update configurations sections in documentations

bcb5027

Refs: XRDCAT-8

raits approved these changes Aug 15, 2024

View reviewed changes

xroad-catalog-collector/README.md Outdated Show resolved Hide resolved

xroad-catalog-lister/README.md Outdated Show resolved Hide resolved

docs: Update list styles in READMEs

5c7aada

Refs: XRDCAT-8

docs: Remove "Required" column from configurations sections in READMEs

7495a16

Refs: XRDCAT-8

melbeltagy merged commit 86ad5bf into develop Aug 15, 2024
3 checks passed

melbeltagy deleted the XRDCAT-8-clearer-profiles branch August 15, 2024 09:32

melbeltagy restored the XRDCAT-8-clearer-profiles branch August 15, 2024 09:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use default profile and switch country-specific profiles into a feature flag #39

Use default profile and switch country-specific profiles into a feature flag #39

melbeltagy commented Jul 30, 2024 •

edited

Loading

github-actions bot commented Jul 30, 2024

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 12, 2024

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 13, 2024

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 13, 2024

X-Road-Catalog tests :: BuildAndTest

raits left a comment

github-actions bot commented Aug 14, 2024

X-Road-Catalog tests :: BuildAndTest

melbeltagy commented Aug 14, 2024

raits left a comment

github-actions bot commented Aug 15, 2024

X-Road-Catalog tests :: BuildAndTest

sonarcloud bot commented Aug 15, 2024

github-actions bot commented Aug 15, 2024

X-Road-Catalog tests :: BuildAndTest

Use default profile and switch country-specific profiles into a feature flag #39

Use default profile and switch country-specific profiles into a feature flag #39

Conversation

melbeltagy commented Jul 30, 2024 • edited Loading

github-actions bot commented Jul 30, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 12, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 13, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

github-actions bot commented Aug 13, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

raits left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 14, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

melbeltagy commented Aug 14, 2024

raits left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 15, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

sonarcloud bot commented Aug 15, 2024

Quality Gate passed

github-actions bot commented Aug 15, 2024

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest

melbeltagy commented Jul 30, 2024 •

edited

Loading