Add the capability to update discovery configuration of the primary organization.

components/org.wso2.carbon.identity.organization.config.service/pom.xml

@@ -45,6 +45,21 @@
             <groupId>org.wso2.carbon.identity.organization.management.core</groupId>
             <artifactId>org.wso2.carbon.identity.organization.management.service</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-inline</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

components/org.wso2.carbon.identity.organization.config.service/src/main/java/org/wso2/carbon/identity/organization/config/service/OrganizationConfigManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com).
+ * Copyright (c) 2023-2024, WSO2 LLC. (http://www.wso2.com).
  *
  * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -20,6 +20,7 @@
 
 import org.wso2.carbon.identity.organization.config.service.exception.OrganizationConfigException;
 import org.wso2.carbon.identity.organization.config.service.model.DiscoveryConfig;
+import org.wso2.carbon.identity.organization.management.service.exception.NotImplementedException;
 
 /**
  * Interface for organization configuration management.
@@ -35,6 +36,19 @@
      */
     void addDiscoveryConfiguration(DiscoveryConfig discoveryConfig) throws OrganizationConfigException;
 
+    /**
+     * Update the discovery configuration of the primary organization.
+     *
+     * @param discoveryConfig The discovery configuration.
+     * @throws OrganizationConfigException The exception thrown when an error occurs while updating the discovery
+     *                                     configuration.
+     */
+    default void updateDiscoveryConfiguration(DiscoveryConfig discoveryConfig) throws OrganizationConfigException {
+
+        throw new NotImplementedException("updateDiscoveryConfiguration method is not implemented in " +
+                this.getClass().getName());
+    }
+
     /**
      * Fetch the discovery configuration of the primary organization.
      *

components/org.wso2.carbon.identity.organization.config.service/src/main/java/org/wso2/carbon/identity/organization/config/service/OrganizationConfigManagerImpl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com).
+ * Copyright (c) 2023-2024, WSO2 LLC. (http://www.wso2.com).
  *
  * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -38,13 +38,16 @@
 import java.util.stream.Collectors;
 
 import static org.wso2.carbon.identity.configuration.mgt.core.constant.ConfigurationConstants.ErrorMessages.ERROR_CODE_RESOURCE_DOES_NOT_EXISTS;
+import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE;
+import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.EMAIL_DOMAIN_ENABLE;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_DISCOVERY_CONFIG_CONFLICT;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_DISCOVERY_CONFIG_NOT_EXIST;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_DISCOVERY_CONFIG_UPDATE_NOT_ALLOWED;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_ERROR_ADDING_DISCOVERY_CONFIG;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_ERROR_DELETING_DISCOVERY_CONFIG;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_ERROR_RETRIEVING_DISCOVERY_CONFIG;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_INVALID_DISCOVERY_ATTRIBUTE;
+import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.ErrorMessages.ERROR_CODE_INVALID_DISCOVERY_ATTRIBUTE_VALUES;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.RESOURCE_NAME;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.RESOURCE_TYPE_NAME;
 import static org.wso2.carbon.identity.organization.config.service.constant.OrganizationConfigConstants.SUPPORTED_DISCOVERY_ATTRIBUTE_KEYS;
@@ -75,6 +78,25 @@
         }
     }
 
+    @Override
+    public void updateDiscoveryConfiguration(DiscoveryConfig discoveryConfig) throws OrganizationConfigException {
+
+        try {
+            if (!isDiscoveryConfigChangeAllowed()) {
+                throw handleClientException(ERROR_CODE_DISCOVERY_CONFIG_UPDATE_NOT_ALLOWED);
+            }
+            Optional<Resource> resourceOptional = getDiscoveryResource();
+            Resource resource = buildResourceFromValidationConfig(discoveryConfig);
+            if (!resourceOptional.isPresent()) {
+                getConfigurationManager().addResource(RESOURCE_TYPE_NAME, resource);
+            } else {
+                getConfigurationManager().replaceResource(RESOURCE_TYPE_NAME, resource);
+            }
+        } catch (ConfigurationManagementException | OrganizationManagementServerException e) {
+            throw handleServerException(ERROR_CODE_ERROR_ADDING_DISCOVERY_CONFIG, e, getOrganizationId());
+        }
+    }
+
     @Override
     public DiscoveryConfig getDiscoveryConfiguration() throws OrganizationConfigException {
 
@@ -158,6 +180,12 @@
             }
             configAttributes.put(key, property.getValue());
         }
+
+        if (Boolean.parseBoolean(configAttributes.get(EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE)) &&
+                !Boolean.parseBoolean(configAttributes.get(EMAIL_DOMAIN_ENABLE))) {
+            throw handleClientException(ERROR_CODE_INVALID_DISCOVERY_ATTRIBUTE_VALUES);
+        }
+
         List<Attribute> resourceAttributes = configAttributes.entrySet().stream()
                 .filter(attribute -> attribute.getValue() != null && !"null".equals(attribute.getValue()))
                 .map(attribute -> new Attribute(attribute.getKey(), attribute.getValue()))

components/org.wso2.carbon.identity.organization.config.service/src/main/java/org/wso2/carbon/identity/organization/config/service/constant/OrganizationConfigConstants.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com).
+ * Copyright (c) 2023-2024, WSO2 LLC. (http://www.wso2.com).
  *
  * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -18,7 +18,6 @@
 
 package org.wso2.carbon.identity.organization.config.service.constant;
 
-import java.util.Collections;
 import java.util.List;
 
 /**
@@ -28,8 +27,10 @@ public class OrganizationConfigConstants {
 
     public static final String RESOURCE_TYPE_NAME = "ORGANIZATION_CONFIGURATION";
     public static final String RESOURCE_NAME = "OrganizationDiscovery";
+    public static final String EMAIL_DOMAIN_ENABLE = "emailDomain.enable";
+    public static final String EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE = "emailDomainBasedSelfSignup.enable";
     public static final List<String> SUPPORTED_DISCOVERY_ATTRIBUTE_KEYS =
-            Collections.singletonList("emailDomain.enable");
+            List.of(EMAIL_DOMAIN_ENABLE, EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE);
     private static final String ORGANIZATION_CONFIGURATION_ERROR_CODE_PREFIX = "OCM-";
 
     /**
@@ -47,6 +48,8 @@ public enum ErrorMessages {
                 "The organization discovery configuration is already for available for the organization with id: %s."),
         ERROR_CODE_INVALID_DISCOVERY_ATTRIBUTE("60004", "Invalid organization discovery attribute.",
                 "The organization discovery attribute with key: %s is not supported."),
+        ERROR_CODE_INVALID_DISCOVERY_ATTRIBUTE_VALUES("60005", "Invalid organization discovery attribute " +
+                "values.", "Provided organization discovery attribute value combination is not supported."),
 
         // Server errors.
         ERROR_CODE_ERROR_ADDING_DISCOVERY_CONFIG("65001", "Unable to add the organization discovery " +

components/org.wso2.carbon.identity.organization.config.service/src/test/java/org/wso2/carbon/identity/organization/config/service/OrganizationConfigManagerImplTest.java

@@ -0,0 +1,207 @@
+/*
+ * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you 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.
+ */
+
+package org.wso2.carbon.identity.organization.config.service;
+
+import org.mockito.Mock;
+import org.mockito.MockedStatic;
+import org.mockito.MockitoAnnotations;
+import org.testng.Assert;
+import org.testng.annotations.AfterClass;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+import org.wso2.carbon.base.CarbonBaseConstants;
+import org.wso2.carbon.context.PrivilegedCarbonContext;
+import org.wso2.carbon.identity.configuration.mgt.core.ConfigurationManager;
+import org.wso2.carbon.identity.configuration.mgt.core.ConfigurationManagerImpl;
+import org.wso2.carbon.identity.configuration.mgt.core.dao.ConfigurationDAO;
+import org.wso2.carbon.identity.configuration.mgt.core.dao.impl.ConfigurationDAOImpl;
+import org.wso2.carbon.identity.configuration.mgt.core.internal.ConfigurationManagerComponentDataHolder;
+import org.wso2.carbon.identity.configuration.mgt.core.model.ConfigurationManagerConfigurationHolder;
+import org.wso2.carbon.identity.core.util.IdentityDatabaseUtil;
+import org.wso2.carbon.identity.core.util.IdentityTenantUtil;
+import org.wso2.carbon.identity.organization.config.service.exception.OrganizationConfigClientException;
+import org.wso2.carbon.identity.organization.config.service.internal.OrganizationConfigServiceHolder;
+import org.wso2.carbon.identity.organization.config.service.model.ConfigProperty;
+import org.wso2.carbon.identity.organization.config.service.model.DiscoveryConfig;
+import org.wso2.carbon.identity.organization.config.service.util.TestUtils;
+import org.wso2.carbon.identity.organization.management.service.OrganizationManager;
+
+import java.nio.file.Paths;
+import java.sql.Connection;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import javax.sql.DataSource;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.mockStatic;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.when;
+
+/**
+ * Unit tests for OrganizationConfigManagerImpl class.
+ */
+public class OrganizationConfigManagerImplTest {
+
+    @Mock
+    private OrganizationManager organizationManager;
+    private final OrganizationConfigManagerImpl organizationConfigManagerImpl = new OrganizationConfigManagerImpl();
+    private AutoCloseable mocks;
+    MockedStatic<IdentityTenantUtil> identityTenantUtil;
+    MockedStatic<IdentityDatabaseUtil> identityDatabaseUtil;
+    MockedStatic<PrivilegedCarbonContext> privilegedCarbonContext;
+    private static final int SUPER_TENANT_ID = -1234;
+    private static final String SUPER_TENANT_DOMAIN_NAME = "carbon.super";
+    private static final String EMAIL_DOMAIN_ENABLE = "emailDomain.enable";
+    private static final String EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE = "emailDomainBasedSelfSignup.enable";
+    private static final String TRUE = "true";
+    private static final String FALSE = "false";
+
+    @BeforeClass
+    public void setUp() throws Exception {
+
+        mocks = MockitoAnnotations.openMocks(this);
+
+        TestUtils.initiateH2Base();
+        setUpCarbonHome();
+        mockCarbonContextForSuperTenant();
+
+        DataSource dataSource = mock(DataSource.class);
+        identityTenantUtil = mockStatic(IdentityTenantUtil.class);
+        identityDatabaseUtil = mockStatic(IdentityDatabaseUtil.class);
+        identityDatabaseUtil.when(IdentityDatabaseUtil::getDataSource).thenReturn(dataSource);
+
+        // Mocking the connection close method to avoid closing the connection before needed.
+        Connection connection = spy(TestUtils.getConnection());
+        doNothing().when(connection).close();
+        when(dataSource.getConnection()).thenReturn(connection);
+
+        ConfigurationManager configurationManager = setUpConfigurationManager(identityTenantUtil);
+        OrganizationConfigServiceHolder.getInstance().setOrganizationManager(organizationManager);
+        when(organizationManager.isPrimaryOrganization(anyString())).thenReturn(true);
+        OrganizationConfigServiceHolder.getInstance().setConfigurationManager(configurationManager);
+    }
+
+    @Test(priority = 1)
+    public void testAddDiscoveryConfiguration() throws Exception {
+
+        List<ConfigProperty> configProperties = new ArrayList<>();
+        configProperties.add(new ConfigProperty(EMAIL_DOMAIN_ENABLE, TRUE));
+        DiscoveryConfig discoveryConfig = new DiscoveryConfig(configProperties);
+
+        organizationConfigManagerImpl.addDiscoveryConfiguration(discoveryConfig);
+        List<ConfigProperty> returnedConfigProperties =
+                organizationConfigManagerImpl.getDiscoveryConfiguration().getConfigProperties();
+
+        Assert.assertEquals(returnedConfigProperties.size(), 1);
+        Assert.assertEquals(returnedConfigProperties.get(0).getKey(), EMAIL_DOMAIN_ENABLE);
+        Assert.assertEquals(returnedConfigProperties.get(0).getValue(), TRUE);
+    }
+
+    @Test(priority = 2)
+    public void testUpdateDiscoveryConfiguration() throws Exception {
+
+        List<ConfigProperty> configProperties = new ArrayList<>();
+        configProperties.add(new ConfigProperty(EMAIL_DOMAIN_ENABLE, TRUE));
+        configProperties.add(new ConfigProperty(EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE, TRUE));
+        DiscoveryConfig discoveryConfig = new DiscoveryConfig(configProperties);
+
+        organizationConfigManagerImpl.updateDiscoveryConfiguration(discoveryConfig);
+        List<ConfigProperty> returnedConfigProperties =
+                organizationConfigManagerImpl.getDiscoveryConfiguration().getConfigProperties();
+
+        Assert.assertEquals(returnedConfigProperties.size(), 2);
+        Assert.assertEquals(returnedConfigProperties.get(0).getKey(), EMAIL_DOMAIN_ENABLE);
+        Assert.assertEquals(returnedConfigProperties.get(0).getValue(), TRUE);
+        Assert.assertEquals(returnedConfigProperties.get(1).getKey(), EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE);
+        Assert.assertEquals(returnedConfigProperties.get(1).getValue(), TRUE);
+    }
+
+    @Test(priority = 3)
+    public void testUpdateDiscoveryConfigurationInvalidConfig() throws Exception {
+
+        try {
+            List<ConfigProperty> configProperties = new ArrayList<>();
+            configProperties.add(new ConfigProperty(EMAIL_DOMAIN_ENABLE, FALSE));
+            configProperties.add(new ConfigProperty(EMAIL_DOMAIN_BASED_SELF_SIGNUP_ENABLE, TRUE));
+            DiscoveryConfig discoveryConfig = new DiscoveryConfig(configProperties);
+
+            organizationConfigManagerImpl.updateDiscoveryConfiguration(discoveryConfig);
+            Assert.fail("Expected OrganizationConfigClientException was not thrown.");
+        } catch (OrganizationConfigClientException e) {
+            Assert.assertEquals(e.getMessage(), "Invalid organization discovery attribute values.");
+        }
+    }
+
+    @Test(priority = 4)
+    public void testDeleteDiscoveryConfiguration() throws Exception {
+
+        try {
+            organizationConfigManagerImpl.deleteDiscoveryConfiguration();
+            organizationConfigManagerImpl.getDiscoveryConfiguration();
+            Assert.fail("Expected OrganizationConfigClientException was not thrown.");
+        } catch (OrganizationConfigClientException e) {
+            Assert.assertEquals(e.getMessage(), "No organization discovery configuration found.");
+        }
+    }
+
+    @AfterClass
+    public void tearDown() throws Exception {
+
+        TestUtils.closeH2Base();
+        mocks.close();
+        identityDatabaseUtil.close();
+        identityTenantUtil.close();
+        privilegedCarbonContext.close();
+    }
+
+    private static ConfigurationManager setUpConfigurationManager(MockedStatic<IdentityTenantUtil> identityTenantUtil) {
+
+        ConfigurationManagerComponentDataHolder.setUseCreatedTime(true);
+        ConfigurationManagerConfigurationHolder configurationHolder = new ConfigurationManagerConfigurationHolder();
+        ConfigurationDAO configurationDAO = new ConfigurationDAOImpl();
+        configurationHolder.setConfigurationDAOS(Collections.singletonList(configurationDAO));
+        identityTenantUtil.when(() -> IdentityTenantUtil.getTenantDomain(any(Integer.class)))
+                .thenReturn(SUPER_TENANT_DOMAIN_NAME);
+        return new ConfigurationManagerImpl(configurationHolder);
+    }
+
+    private void mockCarbonContextForSuperTenant() {
+
+        privilegedCarbonContext = mockStatic(PrivilegedCarbonContext.class);
+        PrivilegedCarbonContext mockPrivilegedCarbonContext = mock(PrivilegedCarbonContext.class);
+
+        privilegedCarbonContext.when(
+                PrivilegedCarbonContext::getThreadLocalCarbonContext).thenReturn(mockPrivilegedCarbonContext);
+        when(mockPrivilegedCarbonContext.getTenantDomain()).thenReturn(SUPER_TENANT_DOMAIN_NAME);
+        when(mockPrivilegedCarbonContext.getTenantId()).thenReturn(SUPER_TENANT_ID);
+        when(mockPrivilegedCarbonContext.getUsername()).thenReturn("admin");
+    }
+
+    private static void setUpCarbonHome() {
+
+        String carbonHome = Paths.get(System.getProperty("user.dir"), "target", "test-classes").toString();
+        System.setProperty(CarbonBaseConstants.CARBON_HOME, carbonHome);
+    }
+
+}