feat: apiml Spring-Modulith based module with Gateway and Discovery services #4051

pablocarle · 2025-04-02T11:23:12Z

Description

Gateway and Discovery as part of Spring Modulith APIML module.

Type of change

feat: New feature (non-breaking change which adds functionality)

Checklist:

My code follows the style guidelines of this project
PR title conforms to commit message guideline ## Commit Message Structure Guideline
I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
The java tests in the area I was working on leverage @nested annotations
Any dependent changes have been merged and published in downstream modules

Signed-off-by: nx673747 <[email protected]>

Signed-off-by: Pablo Carle <[email protected]>

Signed-off-by: nx673747 <[email protected]>

Signed-off-by: Pablo Carle <[email protected]>

…nto reboot/modulith

Signed-off-by: Pablo Carle <[email protected]>

Signed-off-by: Andrea Tabone <[email protected]>

Signed-off-by: Pablo Carle <[email protected]>

Signed-off-by: Andrea Tabone <[email protected]>

…zowe/api-layer into reboot/modulith_security_config

Signed-off-by: Pablo Carle <[email protected]>

apiml/src/main/java/org/zowe/apiml/EurekaConfiguration.java

taban03 · 2025-04-02T13:47:31Z

apiml/src/main/java/org/zowe/apiml/ModulithConfig.java

+            .setInstanceId(String.format("%s:%s:%d", hostname, serviceId, port))
+            .setAppName(serviceId)
+            .setHostName(hostname)
+            .setHomePageUrl(null, String.format("%s://%s:%d", scheme, hostname, port)) //TODO Will it break something else other than catalog?


I guess it's solved?

I need to improve this, it's a quick fix only, thanks for spotting it

apiml/src/main/java/org/zowe/apiml/ModulithConfig.java

Signed-off-by: Pablo Carle <[email protected]>

…nto reboot/modulith

apiml/src/main/java/org/zowe/apiml/filter/HideEurekaFilter.java

apiml/src/main/java/org/zowe/apiml/filter/PreFluxFilter.java

taban03 · 2025-04-02T13:57:21Z

apiml/src/main/resources/apiml-log-messages.yml

+
+    # Service specific messages
+    # 700-999
+    -   key: org.zowe.apiml.common.unauthorized


maybe this import is not necessary, this message is already in common-log-messages.yml which is already included in the MessageService bean, but we should verify it

apiml/src/test/java/org/zowe/apiml/ModularityTests.java

taban03 · 2025-04-02T14:02:30Z

gateway-service/src/main/java/org/zowe/apiml/gateway/filters/security/BasicAuthFilter.java

@@ -32,26 +34,44 @@ public class BasicAuthFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {


some javadoc for this filter would be good too

gateway-service/src/main/java/org/zowe/apiml/gateway/service/GatewayIndexService.java

taban03 · 2025-04-02T14:05:25Z

gateway-service/src/test/java/org/zowe/apiml/gateway/service/GatewayIndexServiceTest.java

    }

+    // TODO Add test when primary registration


gateway-service/src/test/java/org/zowe/apiml/gateway/services/ServicesInfoServiceTest.java

taban03 · 2025-04-02T14:07:06Z

gateway-service/src/test/java/org/zowe/apiml/gateway/services/ServicesInfoServiceTest.java

-        InstanceInfo instance4 = createBasicTestInstance(InstanceInfo.InstanceStatus.UP);
-        List<InstanceInfo> instances = Arrays.asList(instance1, instance2, instance3, instance4);
-        when(eurekaClient.getApplication(CLIENT_SERVICE_ID)).thenReturn(new Application(CLIENT_SERVICE_ID, instances));
+        var instance1 = createBasicTestInstance(InstanceInfo.InstanceStatus.STARTING);


could you put them globally since they are used in more than one test?

...n-tests/src/test/java/org/zowe/apiml/functional/apicatalog/ApiCatalogAuthenticationTest.java

…atewayIndexService.java Co-authored-by: Andrea Tabone <[email protected]> Signed-off-by: Pablo Carle <[email protected]>

Signed-off-by: Pablo Carle <[email protected]>

sonarqubecloud · 2025-04-04T14:42:58Z

Quality Gate failed

Failed conditions
30.2% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

Signed-off-by: Pablo Carle <[email protected]>

nx673747 and others added 30 commits March 21, 2025 10:50

initial commit; adding base for apiml service

04590d1

Signed-off-by: nx673747 <[email protected]>

Merge branch 'v3.x.x' into reboot/modulith

1c240d2

adding modulith dependency and ModulithConfig

3a6bdcc

Signed-off-by: nx673747 <[email protected]>

cherry pick from poc and packaging / test initial changes

f259051

Signed-off-by: Pablo Carle <[email protected]>

fix name of project

f2496f3

Signed-off-by: Pablo Carle <[email protected]>

builds, without test and license check

4041fd9

Signed-off-by: Pablo Carle <[email protected]>

fix some tests, add tasks to package.json

ae6e71a

Signed-off-by: Pablo Carle <[email protected]>

cherry pick from poc, builds w/o test & licensecheck

06076a4

Signed-off-by: Pablo Carle <[email protected]>

fixes eureka bootstrap

1c3c7e0

Signed-off-by: Pablo Carle <[email protected]>

initial metadata fix (not working)

f9365d9

Signed-off-by: Pablo Carle <[email protected]>

add gateway metadata class (to remove?)

051df47

Signed-off-by: Pablo Carle <[email protected]>

add filters to support internal discovery port

72add10

Signed-off-by: Pablo Carle <[email protected]>

gateway metadata, forward to eureka homepage

f2af62f

Signed-off-by: Pablo Carle <[email protected]>

adding zowe license header

0668ad5

Signed-off-by: nx673747 <[email protected]>

merge discovery / gw config, fix route refresh (wip)

5014f25

Signed-off-by: Pablo Carle <[email protected]>

Merge branch 'reboot/modulith' of https://github.com/zowe/api-layer i…

2a266ef

…nto reboot/modulith

fix catalog page redirection with correct discovery client

7ee799b

Signed-off-by: Pablo Carle <[email protected]>

fix checkstyle and some unit tests

7c9d10f

Signed-off-by: Pablo Carle <[email protected]>

fix more tests in discovery service

5297bc2

Signed-off-by: Pablo Carle <[email protected]>

add missing scripts

8555613

Signed-off-by: Pablo Carle <[email protected]>

update gitignore

ab58b9d

Signed-off-by: Pablo Carle <[email protected]>

fix MetadataDefaultsServiceTest

8207ee0

Signed-off-by: Pablo Carle <[email protected]>

fix

2f7fdcb

Signed-off-by: Pablo Carle <[email protected]>

wip - add securityconfig in webflux

2873586

Signed-off-by: Andrea Tabone <[email protected]>

wip start.sh

bab1d3b

Signed-off-by: Pablo Carle <[email protected]>

Merge branch 'reboot/modulith' into reboot/modulith_security_config

a2eeb69

wip z/OS packaging

eff14c8

Signed-off-by: Pablo Carle <[email protected]>

wip

79f6a31

Signed-off-by: Andrea Tabone <[email protected]>

Merge branch 'reboot/modulith_security_config' of https://github.com/…

9e3dce5

…zowe/api-layer into reboot/modulith_security_config

discovery security config wip

f576e4e

Signed-off-by: Pablo Carle <[email protected]>