Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] ldap User Name #17764

Merged
merged 11 commits into from
Sep 23, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@ private void validateMigrations(Jdbi jdbi, OpenMetadataApplicationConfig conf)
connectionType,
conf.getMigrationConfiguration().getExtensionPath(),
conf.getPipelineServiceClientConfiguration(),
conf.getAuthenticationConfiguration(),
false);
migrationWorkflow.loadMigrations();
migrationWorkflow.validateMigrationsForServer();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.jdbi.v3.core.Handle;
import org.openmetadata.schema.api.security.AuthenticationConfiguration;
import org.openmetadata.sdk.PipelineServiceClientInterface;
import org.openmetadata.service.clients.pipeline.PipelineServiceClientFactory;
import org.openmetadata.service.jdbi3.CollectionDAO;
Expand All @@ -24,6 +25,7 @@ public class MigrationProcessImpl implements MigrationProcess {
protected CollectionDAO collectionDAO;
protected Handle handle;
protected PipelineServiceClientInterface pipelineServiceClient;
protected AuthenticationConfiguration authenticationConfiguration;
private final MigrationFile migrationFile;

public @Getter MigrationContext context;
Expand All @@ -40,6 +42,7 @@ public void initialize(Handle handle) {
this.pipelineServiceClient =
PipelineServiceClientFactory.createPipelineServiceClient(
this.migrationFile.pipelineServiceClientConfiguration);
this.authenticationConfiguration = migrationFile.authenticationConfiguration;
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import org.jdbi.v3.core.Jdbi;
import org.json.JSONObject;
import org.openmetadata.schema.api.configuration.pipelineServiceClient.PipelineServiceClientConfiguration;
import org.openmetadata.schema.api.security.AuthenticationConfiguration;
import org.openmetadata.service.jdbi3.MigrationDAO;
import org.openmetadata.service.jdbi3.locator.ConnectionType;
import org.openmetadata.service.migration.QueryStatus;
Expand All @@ -35,6 +36,7 @@ public class MigrationWorkflow {
private final ConnectionType connectionType;
private final String extensionSQLScriptRootPath;
@Getter private final PipelineServiceClientConfiguration pipelineServiceClientConfiguration;
@Getter private final AuthenticationConfiguration authenticationConfiguration;
private final MigrationDAO migrationDAO;
private final Jdbi jdbi;
private final boolean forceMigrations;
Expand All @@ -47,6 +49,7 @@ public MigrationWorkflow(
ConnectionType connectionType,
String extensionSQLScriptRootPath,
PipelineServiceClientConfiguration pipelineServiceClientConfiguration,
AuthenticationConfiguration authenticationConfiguration,
boolean forceMigrations) {
this.jdbi = jdbi;
this.migrationDAO = jdbi.onDemand(MigrationDAO.class);
Expand All @@ -55,6 +58,7 @@ public MigrationWorkflow(
this.connectionType = connectionType;
this.extensionSQLScriptRootPath = extensionSQLScriptRootPath;
this.pipelineServiceClientConfiguration = pipelineServiceClientConfiguration;
this.authenticationConfiguration = authenticationConfiguration;
}

public void loadMigrations() {
Expand All @@ -64,7 +68,8 @@ public void loadMigrations() {
nativeSQLScriptRootPath,
connectionType,
extensionSQLScriptRootPath,
pipelineServiceClientConfiguration);
pipelineServiceClientConfiguration,
authenticationConfiguration);
// Filter Migrations to Be Run
this.migrations = filterAndGetMigrationsToRun(availableMigrations);
}
Expand All @@ -83,10 +88,15 @@ public List<MigrationFile> getMigrationFiles(
String nativeSQLScriptRootPath,
ConnectionType connectionType,
String extensionSQLScriptRootPath,
PipelineServiceClientConfiguration pipelineServiceClientConfiguration) {
PipelineServiceClientConfiguration pipelineServiceClientConfiguration,
AuthenticationConfiguration authenticationConfiguration) {
List<MigrationFile> availableOMNativeMigrations =
getMigrationFilesFromPath(
nativeSQLScriptRootPath, connectionType, pipelineServiceClientConfiguration, false);
nativeSQLScriptRootPath,
connectionType,
pipelineServiceClientConfiguration,
authenticationConfiguration,
false);

// If we only have OM migrations, return them
if (extensionSQLScriptRootPath == null || extensionSQLScriptRootPath.isEmpty()) {
Expand All @@ -96,7 +106,11 @@ public List<MigrationFile> getMigrationFiles(
// Otherwise, fetch the extension migrations and sort the executions
List<MigrationFile> availableExtensionMigrations =
getMigrationFilesFromPath(
extensionSQLScriptRootPath, connectionType, pipelineServiceClientConfiguration, true);
extensionSQLScriptRootPath,
connectionType,
pipelineServiceClientConfiguration,
authenticationConfiguration,
true);

/*
If we create migrations version as:
Expand All @@ -114,6 +128,7 @@ public List<MigrationFile> getMigrationFilesFromPath(
String path,
ConnectionType connectionType,
PipelineServiceClientConfiguration pipelineServiceClientConfiguration,
AuthenticationConfiguration authenticationConfiguration,
Boolean isExtension) {
return Arrays.stream(Objects.requireNonNull(new File(path).listFiles(File::isDirectory)))
.map(
Expand All @@ -123,6 +138,7 @@ public List<MigrationFile> getMigrationFilesFromPath(
migrationDAO,
connectionType,
pipelineServiceClientConfiguration,
authenticationConfiguration,
isExtension))
.sorted()
.toList();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.openmetadata.service.migration.mysql.v153;

import static org.openmetadata.service.migration.utils.v153.MigrationUtil.updateEmailTemplates;
import static org.openmetadata.service.migration.utils.v153.MigrationUtil.updateUserNameToEmailPrefixForLdapAuthProvider;

import lombok.SneakyThrows;
import org.openmetadata.service.migration.api.MigrationProcessImpl;
Expand All @@ -16,5 +17,6 @@ public Migration(MigrationFile migrationFile) {
@SneakyThrows
public void runDataMigration() {
updateEmailTemplates(collectionDAO);
updateUserNameToEmailPrefixForLdapAuthProvider(collectionDAO, authenticationConfiguration);
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.openmetadata.service.migration.postgres.v153;

import static org.openmetadata.service.migration.utils.v153.MigrationUtil.updateEmailTemplates;
import static org.openmetadata.service.migration.utils.v153.MigrationUtil.updateUserNameToEmailPrefixForLdapAuthProvider;

import lombok.SneakyThrows;
import org.openmetadata.service.migration.api.MigrationProcessImpl;
Expand All @@ -16,5 +17,6 @@ public Migration(MigrationFile migrationFile) {
@SneakyThrows
public void runDataMigration() {
updateEmailTemplates(collectionDAO);
updateUserNameToEmailPrefixForLdapAuthProvider(collectionDAO, authenticationConfiguration);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import org.flywaydb.core.internal.sqlscript.SqlStatementIterator;
import org.flywaydb.database.mysql.MySQLParser;
import org.openmetadata.schema.api.configuration.pipelineServiceClient.PipelineServiceClientConfiguration;
import org.openmetadata.schema.api.security.AuthenticationConfiguration;
import org.openmetadata.service.jdbi3.MigrationDAO;
import org.openmetadata.service.jdbi3.locator.ConnectionType;
import org.openmetadata.service.util.EntityUtil;
Expand All @@ -23,6 +24,8 @@ public class MigrationFile implements Comparable<MigrationFile> {
public final String version;
public final ConnectionType connectionType;
public final PipelineServiceClientConfiguration pipelineServiceClientConfiguration;
public final AuthenticationConfiguration authenticationConfiguration;

public final File dir;
public final Boolean isExtension;
public final String dbPackageName;
Expand All @@ -38,13 +41,15 @@ public MigrationFile(
MigrationDAO migrationDAO,
ConnectionType connectionType,
PipelineServiceClientConfiguration pipelineServiceClientConfiguration,
AuthenticationConfiguration authenticationConfiguration,
Boolean isExtension) {
this.dir = dir;
this.isExtension = isExtension;
this.version = dir.getName();
this.connectionType = connectionType;
this.migrationDAO = migrationDAO;
this.pipelineServiceClientConfiguration = pipelineServiceClientConfiguration;
this.authenticationConfiguration = authenticationConfiguration;
this.dbPackageName = connectionType == ConnectionType.MYSQL ? "mysql" : "postgres";
versionNumbers = convertToNumber(version);
schemaChanges = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
package org.openmetadata.service.migration.utils.v153;

import java.util.List;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.api.security.AuthenticationConfiguration;
import org.openmetadata.schema.entity.teams.User;
import org.openmetadata.schema.services.connections.metadata.AuthProvider;
import org.openmetadata.service.jdbi3.CollectionDAO;
import org.openmetadata.service.util.JsonUtils;

@Slf4j
public class MigrationUtil {
Expand All @@ -11,4 +16,27 @@ public static void updateEmailTemplates(CollectionDAO collectionDAO) {
// delete emailTemplates, it will be loaded from initSeedData.
dao.deleteEmailTemplates();
}

public static void updateUserNameToEmailPrefixForLdapAuthProvider(
CollectionDAO daoCollection, AuthenticationConfiguration config) {
if (config.getProvider().equals(AuthProvider.LDAP)) {
LOG.info("Starting migration username -> email prefix");
int total = daoCollection.userDAO().listTotalCount();
int offset = 0;
int limit = 200;
while (offset < total) {
List<String> userEntities = daoCollection.userDAO().listAfterWithOffset(limit, offset);
for (String json : userEntities) {
User userEntity = JsonUtils.readValue(json, User.class);
String email = userEntity.getEmail();
String emailPrefix = email.substring(0, email.indexOf("@"));
userEntity.setFullyQualifiedName(emailPrefix);
Siddhanttimeline marked this conversation as resolved.
Show resolved Hide resolved

daoCollection.userDAO().update(userEntity);
}
offset = offset + limit;
}
LOG.info("Completed migrating username -> email prefix");
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,7 @@ private void validateAndRunSystemDataMigrations(boolean force) {
connType,
extensionSQLScriptRootPath,
config.getPipelineServiceClientConfiguration(),
config.getAuthenticationConfiguration(),
force);
workflow.loadMigrations();
workflow.printMigrationInfo();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import org.junit.jupiter.api.TestInstance;
import org.openmetadata.common.utils.CommonUtil;
import org.openmetadata.schema.api.configuration.pipelineServiceClient.PipelineServiceClientConfiguration;
import org.openmetadata.schema.api.security.AuthenticationConfiguration;
import org.openmetadata.schema.service.configuration.elasticsearch.ElasticSearchConfiguration;
import org.openmetadata.schema.type.IndexMappingLanguage;
import org.openmetadata.service.jdbi3.CollectionDAO;
Expand Down Expand Up @@ -208,6 +209,7 @@ public void createApplication() throws Exception {
nativeMigrationScriptsLocation,
extensionMigrationScripsLocation,
null,
null,
false);
createIndices();
APP.before();
Expand All @@ -221,6 +223,7 @@ public static void validateAndRunSystemDataMigrations(
String nativeMigrationSQLPath,
String extensionSQLScriptRootPath,
PipelineServiceClientConfiguration pipelineServiceClientConfiguration,
AuthenticationConfiguration authenticationConfiguration,
boolean forceMigrations) {
DatasourceConfig.initialize(connType.label);
MigrationWorkflow workflow =
Expand All @@ -230,6 +233,7 @@ public static void validateAndRunSystemDataMigrations(
connType,
extensionSQLScriptRootPath,
pipelineServiceClientConfiguration,
authenticationConfiguration,
forceMigrations);
// Initialize search repository
SearchRepository searchRepository =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static void setup() {
migrationWorkflow =
spy(
new MigrationWorkflow(
jdbi, "nativePath", ConnectionType.MYSQL, "extensionPath", null, false));
jdbi, "nativePath", ConnectionType.MYSQL, "extensionPath", null, null, false));

omMigrationList =
List.of(
Expand All @@ -37,18 +37,21 @@ public static void setup() {
null,
ConnectionType.MYSQL,
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration(),
false),
new MigrationFile(
new File("/bootstrap/sql/migrations/native/1.2.0"),
null,
ConnectionType.MYSQL,
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration(),
false),
new MigrationFile(
new File("/bootstrap/sql/migrations/native/1.2.1"),
null,
ConnectionType.MYSQL,
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration(),
false));

collateMigrationList =
Expand All @@ -58,12 +61,14 @@ public static void setup() {
null,
ConnectionType.MYSQL,
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration(),
true),
new MigrationFile(
new File("/bootstrap-collate/sql/migrations/native/1.2.2-collate"),
null,
ConnectionType.MYSQL,
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration(),
true));
}

Expand All @@ -72,18 +77,19 @@ void test_getMigrationFiles() {
Mockito.doReturn(omMigrationList)
.when(migrationWorkflow)
.getMigrationFilesFromPath(
eq("nativePath"), any(ConnectionType.class), eq(null), eq(false));
eq("nativePath"), any(ConnectionType.class), eq(null), eq(null), eq(false));
Mockito.doReturn(collateMigrationList)
.when(migrationWorkflow)
.getMigrationFilesFromPath(
eq("extensionPath"), any(ConnectionType.class), eq(null), eq(true));
eq("extensionPath"), any(ConnectionType.class), eq(null), eq(null), eq(true));

List<MigrationFile> foundList =
migrationWorkflow.getMigrationFiles(
"nativePath",
ConnectionType.MYSQL,
"extensionPath",
migrationWorkflow.getPipelineServiceClientConfiguration());
migrationWorkflow.getPipelineServiceClientConfiguration(),
migrationWorkflow.getAuthenticationConfiguration());

assertEquals(
List.of("1.1.0", "1.1.0-collate", "1.2.0", "1.2.1", "1.2.2-collate"),
Expand Down
Loading