Merge branch 'OZG-6741-Organisationseinheit-link' into 'main'

Ozg 6741 organisationseinheit link

See merge request !1

Jenkinsfile

@@ -226,7 +226,7 @@ String getHelmRepository(){
 }
 
 String validateBranchName(branchName) {
-    int maxLength = 30
+    int maxLength = 20
     if (branchName.length() > maxLength) {
         String originalBranchName = branchName
         branchName = branchName.substring(0, maxLength)

src/main/helm/templates/deployment.yaml

@@ -123,6 +123,10 @@ spec:
           - name: ozgcloud_feature_organisationsEinheiten
             value: {{ .Values.ozgcloud.feature.organisationsEinheiten | quote }}
           {{- end }}
+          {{- if eq ((.Values.ozgcloud).feature).organisationsEinheiten "true" }}
+          - name: ozgcloud_organisationeinheit_zufisearchuri
+            value: {{ required "ozgcloud.organisationEinheit.zufiSearchUri must be set if feature organisationsEinheiten is activated" ((.Values.ozgcloud).organisationEinheit).zufiSearchUri}}
+          {{- end }}
         envFrom:
           {{- if (.Values.database).useExternal }}
           - secretRef:

src/main/helm/values.yaml

@@ -34,7 +34,7 @@ ozgcloud:
       user: administrationApiUser
 
 zufiManager:
-  address: zufi-server.zufi:9090
+  address: dns:///zufi-server.zufi:9090
 
 image:
   repo: docker.ozg-sh.de

src/main/java/de/ozgcloud/admin/organisationseinheit/OrganisationEinheitProperties.java

+/*
+ * Copyright (C) 2025 Das Land Schleswig-Holstein vertreten durch den
+ * Ministerpräsidenten des Landes Schleswig-Holstein
+ * Staatskanzlei
+ * Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+ *
+ * Lizenziert unter der EUPL, Version 1.2 oder - sobald
+ * diese von der Europäischen Kommission genehmigt wurden -
+ * Folgeversionen der EUPL ("Lizenz");
+ * Sie dürfen dieses Werk ausschließlich gemäß
+ * dieser Lizenz nutzen.
+ * Eine Kopie der Lizenz finden Sie hier:
+ *
+ * https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+ *
+ * Sofern nicht durch anwendbare Rechtsvorschriften
+ * gefordert oder in schriftlicher Form vereinbart, wird
+ * die unter der Lizenz verbreitete Software "so wie sie
+ * ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+ * ausdrücklich oder stillschweigend - verbreitet.
+ * Die sprachspezifischen Genehmigungen und Beschränkungen
+ * unter der Lizenz sind dem Lizenztext zu entnehmen.
+ */
+package de.ozgcloud.admin.organisationseinheit;
+
+import jakarta.validation.constraints.NotBlank;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+import de.ozgcloud.admin.common.FeatureToggleProperties;
+import lombok.Getter;
+import lombok.Setter;
+
+@Setter
+@Getter
+@Configuration
+@ConfigurationProperties(prefix = OrganisationEinheitProperties.ORGANISATION_EINHEIT_PROPERTIES_PREFIX)
+@ConditionalOnProperty(prefix = FeatureToggleProperties.FEATURE_TOGGLE_PREFIX, name = "organisations-einheiten", havingValue = "true")
+class OrganisationEinheitProperties {
+
+	static final String ORGANISATION_EINHEIT_PROPERTIES_PREFIX = "ozgcloud.organisation-einheit";
+
+	/*
+	 * Uri pointing to the endpoint in Alfa that searches for Organisationseinheiten
+	 * in Zufi
+	 */
+	@NotBlank
+	private String zufiSearchUri;
+}

src/main/java/de/ozgcloud/admin/organisationseinheit/OrganisationsEinheitRootProcessor.java

@@ -25,25 +25,42 @@ package de.ozgcloud.admin.organisationseinheit;
 
 import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.*;
 
+import java.util.List;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.hateoas.EntityModel;
+import org.springframework.hateoas.Link;
 import org.springframework.hateoas.server.RepresentationModelProcessor;
 import org.springframework.stereotype.Component;
 
 import de.ozgcloud.admin.Root;
 import de.ozgcloud.admin.common.FeatureToggleProperties;
+import de.ozgcloud.admin.common.user.CurrentUserService;
+import de.ozgcloud.admin.common.user.UserRole;
 import lombok.RequiredArgsConstructor;
 
 @Component
 @RequiredArgsConstructor
+@ConditionalOnProperty(prefix = FeatureToggleProperties.FEATURE_TOGGLE_PREFIX, name = "organisations-einheiten", havingValue = "true")
 class OrganisationsEinheitRootProcessor implements RepresentationModelProcessor<EntityModel<Root>> {
 
-	static final String REL_ORGANISATIONS_EINHEITEN = "organisationsEinheiten";
+	static final String REL_ORGANISATION_EINHEITEN = "organisationsEinheiten";
+	static final String REL_SEARCH_ORGANISATION_EINHEIT = "searchOrganisationEinheit";
 
-	private final FeatureToggleProperties featureToggleProperties;
+	private final OrganisationEinheitProperties organisationsEinheitProperties;
+	private final CurrentUserService currentUserService;
 
 	@Override
 	public EntityModel<Root> process(EntityModel<Root> model) {
-		return model.addIf(featureToggleProperties.isOrganisationsEinheiten(),
-				() -> linkTo(methodOn(OrganisationsEinheitController.class).getAll()).withRel(REL_ORGANISATIONS_EINHEITEN));
+		return model.addAllIf(currentUserService.hasRole(UserRole.ADMIN_ADMIN),
+				() -> List.of(buildGetAllOrganisationEinheitenLink(), buildSearchOrganisationEinheitLink()));
+	}
+
+	private Link buildGetAllOrganisationEinheitenLink() {
+		return linkTo(methodOn(OrganisationsEinheitController.class).getAll()).withRel(REL_ORGANISATION_EINHEITEN);
+	}
+
+	private Link buildSearchOrganisationEinheitLink() {
+		return Link.of(organisationsEinheitProperties.getZufiSearchUri(), REL_SEARCH_ORGANISATION_EINHEIT);
 	}
 }

src/test/helm/deployment_features_test.yaml

@@ -60,6 +60,8 @@ tests:
           postfach: "true"
           benutzerRollen: "true"
           organisationsEinheiten: "true"
+        organisationEinheit:
+          zufiSearchUri: alfa/zufi/search/endpoint?searchBy={searchBy}
     asserts:
       - contains:
           path: spec.template.spec.containers[0].env

src/test/helm/deployment_zufi_test.yaml

+#
+# Copyright (C) 2025 Das Land Schleswig-Holstein vertreten durch den
+# Ministerpräsidenten des Landes Schleswig-Holstein
+# Staatskanzlei
+# Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+#
+# Lizenziert unter der EUPL, Version 1.2 oder - sobald
+# diese von der Europäischen Kommission genehmigt wurden -
+# Folgeversionen der EUPL ("Lizenz");
+# Sie dürfen dieses Werk ausschließlich gemäß
+# dieser Lizenz nutzen.
+# Eine Kopie der Lizenz finden Sie hier:
+#
+# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+#
+# Sofern nicht durch anwendbare Rechtsvorschriften
+# gefordert oder in schriftlicher Form vereinbart, wird
+# die unter der Lizenz verbreitete Software "so wie sie
+# ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+# ausdrücklich oder stillschweigend - verbreitet.
+# Die sprachspezifischen Genehmigungen und Beschränkungen
+# unter der Lizenz sind dem Lizenztext zu entnehmen.
+#
+
+suite: test zufi search property
+release:
+  name: administration
+  namespace: sh-helm-test
+templates:
+  - templates/deployment.yaml
+set:
+  ozgcloud:
+    bundesland: sh
+    bezeichner: helm
+  sso:
+    serverUrl: https://sso.company.local
+  imagePullSecret: image-pull-secret
+tests:
+  - it: should not contain zufi search uri if organisationseinheit feature toggle not set
+    set:
+      ozgcloud:
+        feature:
+          organisationsEinheiten: "false"
+        organisationEinheit:
+          zufiSearchUri: alfa/zufi/search/endpoint?searchBy={searchBy}
+    asserts:
+      - notContains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: ozgcloud_organisationeinheit_zufisearchuri
+          any: true
+  - it: should not contain zufi search uri if organisationseinheit feature toggle is disabled
+    set:
+      ozgcloud:
+        organisationEinheit:
+          zufiSearchUri: alfa/zufi/search/endpoint?searchBy={searchBy}
+    asserts:
+      - notContains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: ozgcloud_organisationeinheit_zufisearchuri
+          any: true
+  - it: should set zufi search uri
+    set:
+      ozgcloud:
+        feature:
+          organisationsEinheiten: "true"
+        organisationEinheit:
+          zufiSearchUri: alfa/zufi/search/endpoint?searchBy={searchBy}
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: ozgcloud_organisationeinheit_zufisearchuri
+            value: alfa/zufi/search/endpoint?searchBy={searchBy}
+  - it: should fail if zufi search uri is not set
+    set:
+      ozgcloud:
+        feature:
+          organisationsEinheiten: "true"
+    asserts:
+      - failedTemplate:
+          errorMessage: "ozgcloud.organisationEinheit.zufiSearchUri must be set if feature organisationsEinheiten is activated"

src/test/java/de/ozgcloud/admin/organisationseinheit/OrganisationsEinheitRootProcessorITCase.java

+/*
+ * Copyright (C) 2025 Das Land Schleswig-Holstein vertreten durch den
+ * Ministerpräsidenten des Landes Schleswig-Holstein
+ * Staatskanzlei
+ * Abteilung Digitalisierung und zentrales IT-Management der Landesregierung
+ *
+ * Lizenziert unter der EUPL, Version 1.2 oder - sobald
+ * diese von der Europäischen Kommission genehmigt wurden -
+ * Folgeversionen der EUPL ("Lizenz");
+ * Sie dürfen dieses Werk ausschließlich gemäß
+ * dieser Lizenz nutzen.
+ * Eine Kopie der Lizenz finden Sie hier:
+ *
+ * https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+ *
+ * Sofern nicht durch anwendbare Rechtsvorschriften
+ * gefordert oder in schriftlicher Form vereinbart, wird
+ * die unter der Lizenz verbreitete Software "so wie sie
+ * ist", OHNE JEGLICHE GEWÄHRLEISTUNG ODER BEDINGUNGEN -
+ * ausdrücklich oder stillschweigend - verbreitet.
+ * Die sprachspezifischen Genehmigungen und Beschränkungen
+ * unter der Lizenz sind dem Lizenztext zu entnehmen.
+ */
+package de.ozgcloud.admin.organisationseinheit;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationContext;
+
+import de.ozgcloud.common.test.ITCase;
+
+class OrganisationsEinheitRootProcessorITCase {
+
+	@Nested
+	@SpringBootTest(properties = {
+			"ozgcloud.feature.organisations-einheiten=true",
+			"ozgcloud.organisation-einheit.zufi-search-url=foo"
+	})
+
+	@ITCase
+	class TestFeatureEnabled {
+
+		@Autowired
+		private ApplicationContext applicationContext;
+
+		@Test
+		void shouldHaveOrganisationsEinheitRootProcessorBean() {
+			assertDoesNotThrow(() -> applicationContext.getBean(OrganisationsEinheitRootProcessor.class));
+		}
+	}
+
+	@Nested
+	@SpringBootTest(properties = { "ozgcloud.feature.organisations-einheiten=false", "ozgcloud.organisation-einheit.zufi-search-url=foo" })
+	@ITCase
+	class TestFeatureDisabled {
+
+		@Autowired
+		private ApplicationContext applicationContext;
+
+		@Test
+		void shouldHaveOrganisationsEinheitRootProcessorBean() {
+			assertThrows(NoSuchBeanDefinitionException.class, () -> applicationContext.getBean(OrganisationsEinheitRootProcessor.class));
+		}
+	}
+}
\ No newline at end of file

src/test/java/de/ozgcloud/admin/organisationseinheit/OrganisationsEinheitRootProcessorTest.java

@@ -24,8 +24,10 @@
 package de.ozgcloud.admin.organisationseinheit;
 
 import static org.assertj.core.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.mockito.InjectMocks;
@@ -33,61 +35,122 @@ import org.mockito.Mock;
 import org.springframework.hateoas.EntityModel;
 import org.springframework.hateoas.Link;
 
+import com.thedeanda.lorem.LoremIpsum;
+
+import de.ozgcloud.admin.Root;
 import de.ozgcloud.admin.RootTestFactory;
-import de.ozgcloud.admin.common.FeatureToggleProperties;
+import de.ozgcloud.admin.common.user.CurrentUserService;
+import de.ozgcloud.admin.common.user.UserRole;
 
 class OrganisationsEinheitRootProcessorTest {
 
 	@InjectMocks
 	private OrganisationsEinheitRootProcessor organisationsEinheitRootProcessor;
 	@Mock
-	private FeatureToggleProperties featureToggleProperties;
+	private OrganisationEinheitProperties organisationsEinheitProperties;
+	@Mock
+	private CurrentUserService currentUserService;
 
 	@Nested
 	class TestProcess {
 
-		@Nested
-		class OrganisationsEinheitenLinkRelation {
+		private final String zufiSearchUri = LoremIpsum.getInstance().getUrl() + "?searchBy={searchBy}";
 
 		@Test
-			void shouldExistsIfFeatureEnabled() {
-				givenFeatureIsEnabled();
+		void shouldCheckUserRole() {
+			processModel();
+
+			verify(currentUserService).hasRole(UserRole.ADMIN_ADMIN);
+		}
 
-				var model = organisationsEinheitRootProcessor.process(EntityModel.of(RootTestFactory.create()));
+		@Nested
+		class TestOnWrongUserRole {
 
-				assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_ORGANISATIONS_EINHEITEN)).isNotEmpty();
+			@BeforeEach
+			void givenHasWrongRole() {
+				when(currentUserService.hasRole(anyString())).thenReturn(false);
 			}
 
 			@Test
-			void shouldNotExistIfFeatureDisabled() {
-				givenFeatureIsDisabled();
+			void shouldNotAddAnyLinks() {
+				var model = processModel();
+
+				assertThat(model.getLinks()).isEmpty();
+			}
+		}
 
-				var model = organisationsEinheitRootProcessor.process(EntityModel.of(RootTestFactory.create()));
+		@Nested
+		class TestOnAdminRole {
 
-				assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_ORGANISATIONS_EINHEITEN)).isEmpty();
+			@BeforeEach
+			void givenHasAdminRole() {
+				when(currentUserService.hasRole(anyString())).thenReturn(true);
+				when(organisationsEinheitProperties.getZufiSearchUri()).thenReturn(zufiSearchUri);
 			}
 
+			@Nested
+			class TestOrganisationsEinheitenLinkRelation {
+
 				@Test
-			void shouldHaveHref() {
-				givenFeatureIsEnabled();
+				void shouldExist() {
+					var model = processModel();
+
+					assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_ORGANISATION_EINHEITEN)).isNotEmpty();
+				}
 
-				var model = organisationsEinheitRootProcessor.process(EntityModel.of(RootTestFactory.create()));
+				@Test
+				void shouldHaveHref() {
+					var model = processModel();
 
-				assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_ORGANISATIONS_EINHEITEN))
+					assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_ORGANISATION_EINHEITEN))
 							.get()
 							.extracting(Link::getHref)
 							.isEqualTo(OrganisationsEinheitController.PATH);
 				}
+			}
+
+			@Nested
+			class TestSearchOrganisationsEinheitenLink {
 
-			private void givenFeatureIsEnabled() {
-				when(featureToggleProperties.isOrganisationsEinheiten()).thenReturn(true);
+				@Test
+				void shouldExistsIfFeatureEnabled() {
+					var model = processModel();
+
+					assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_SEARCH_ORGANISATION_EINHEIT)).isNotEmpty();
 				}
 
-			private void givenFeatureIsDisabled() {
-				when(featureToggleProperties.isOrganisationsEinheiten()).thenReturn(false);
+				@Test
+				void shouldGetZufiSearchUri() {
+					processModel();
+
+					verify(organisationsEinheitProperties).getZufiSearchUri();
+
 				}
+
+				@Test
+				void shouldHaveHref() {
+					var model = processModel();
+
+					assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_SEARCH_ORGANISATION_EINHEIT))
+							.get()
+							.extracting(Link::getHref)
+							.isEqualTo(zufiSearchUri);
 				}
 
+				@Test
+				void shouldBeTemplated() {
+					var model = processModel();
+
+					assertThat(model.getLink(OrganisationsEinheitRootProcessor.REL_SEARCH_ORGANISATION_EINHEIT))
+							.get()
+							.extracting(Link::isTemplated)
+							.isEqualTo(true);
+				}
+			}
 		}
 
+		private EntityModel<Root> processModel() {
+			return organisationsEinheitRootProcessor.process(EntityModel.of(RootTestFactory.create()));
+		}
+	}
 }
\ No newline at end of file