From a196492676ffa49cc9df1f2c20cd916cacf5e212 Mon Sep 17 00:00:00 2001 From: Zipeng WU Date: Thu, 5 May 2022 08:45:50 +0200 Subject: [PATCH] SONAR-16303 migrate plugin file hash to force reloading rules --- .../db/migration/version/v95/DbVersion95.java | 1 + .../version/v95/OverwritePluginFileHash.java | 42 +++++++++ .../v95/OverwritePluginFileHashTest.java | 89 +++++++++++++++++++ .../OverwritePluginFileHashTest/schema.sql | 12 +++ 4 files changed, 144 insertions(+) create mode 100644 server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHash.java create mode 100644 server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest.java create mode 100644 server/sonar-db-migration/src/test/resources/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest/schema.sql diff --git a/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/DbVersion95.java b/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/DbVersion95.java index bbdc14b3587..2b2652dfeb6 100644 --- a/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/DbVersion95.java +++ b/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/DbVersion95.java @@ -36,6 +36,7 @@ public class DbVersion95 implements DbVersion { .add(6408, "Drop column DESCRIPTIONS from RULES table", DropRuleDescriptionColumn.class) .add(6409, "Drop column CREATED_AT from RULES_METADATA table", DropRuleMetadataCreatedAtColumn.class) .add(6410, "Drop column UPDATED_AT from RULES_METADATA table", DropRuleMetadataUpdatedAtColumn.class) + .add(6411, "Overwrite plugin file hash to force reloading rules", OverwritePluginFileHash.class) ; } } diff --git a/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHash.java b/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHash.java new file mode 100644 index 00000000000..578aca5a790 --- /dev/null +++ b/server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHash.java @@ -0,0 +1,42 @@ +/* + * SonarQube + * Copyright (C) 2009-2022 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +package org.sonar.server.platform.db.migration.version.v95; + +import com.google.common.annotations.VisibleForTesting; +import java.sql.SQLException; +import org.sonar.db.Database; +import org.sonar.server.platform.db.migration.step.DataChange; +import org.sonar.server.platform.db.migration.step.Upsert; + +public class OverwritePluginFileHash extends DataChange { + @VisibleForTesting + static final String OVERWRITE_HASH = "cccccccccccccccccccccccccccccccc"; + + public OverwritePluginFileHash(Database db) { + super(db); + } + + @Override protected void execute(Context context) throws SQLException { + Upsert upsert = context.prepareUpsert("update plugins set file_hash = ? "); + upsert.setString(1, OVERWRITE_HASH); + upsert.execute(); + upsert.commit(); + } +} diff --git a/server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest.java b/server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest.java new file mode 100644 index 00000000000..57f0e9bf3ac --- /dev/null +++ b/server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest.java @@ -0,0 +1,89 @@ +/* + * SonarQube + * Copyright (C) 2009-2022 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +package org.sonar.server.platform.db.migration.version.v95; + +import java.sql.SQLException; +import java.util.HashMap; +import java.util.Map; +import org.junit.Rule; +import org.junit.Test; +import org.sonar.core.util.UuidFactory; +import org.sonar.core.util.UuidFactoryFast; +import org.sonar.db.CoreDbTester; +import org.sonar.server.platform.db.migration.step.DataChange; + +import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic; +import static org.assertj.core.api.Assertions.assertThat; +import static org.sonar.server.platform.db.migration.version.v95.OverwritePluginFileHash.OVERWRITE_HASH; + +public class OverwritePluginFileHashTest { + private final UuidFactory uuidFactory = UuidFactoryFast.getInstance(); + + @Rule + public CoreDbTester db = CoreDbTester.createForSchema(OverwritePluginFileHashTest.class, "schema.sql"); + + private final DataChange underTest = new OverwritePluginFileHash(db.database()); + + @Test + public void migration_overwrite_file_hash_on_all_plugins() throws SQLException { + String pluginUuid1 = insertPlugin(); + String pluginUuid2 = insertPlugin(); + + underTest.execute(); + + assertPluginFileHashOverwrite(pluginUuid1); + assertPluginFileHashOverwrite(pluginUuid2); + } + + @Test + public void migration_should_be_reentrant() throws SQLException { + String pluginUuid1 = insertPlugin(); + String pluginUuid2 = insertPlugin(); + + underTest.execute(); + // re-entrant + underTest.execute(); + + assertPluginFileHashOverwrite(pluginUuid1); + assertPluginFileHashOverwrite(pluginUuid2); + } + + private void assertPluginFileHashOverwrite(String pluginUuid) { + String selectSql = String.format("select file_hash from plugins where uuid='%s'", pluginUuid); + var selectResult = db.select(selectSql); + assertThat(selectResult.get(0)).containsEntry("FILE_HASH", OVERWRITE_HASH); + } + + private String insertPlugin() { + Map map = new HashMap<>(); + String uuid = uuidFactory.create(); + map.put("UUID", uuid); + map.put("KEE", randomAlphabetic(20)); + map.put("FILE_HASH", randomAlphabetic(32)); + map.put("CREATED_AT", System.currentTimeMillis()); + map.put("UPDATED_AT", System.currentTimeMillis()); + map.put("TYPE", "EXTERNAL"); + map.put("REMOVED", false); + db.executeInsert("plugins", map); + + return uuid; + } + +} diff --git a/server/sonar-db-migration/src/test/resources/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest/schema.sql b/server/sonar-db-migration/src/test/resources/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest/schema.sql new file mode 100644 index 00000000000..d51d6260dab --- /dev/null +++ b/server/sonar-db-migration/src/test/resources/org/sonar/server/platform/db/migration/version/v95/OverwritePluginFileHashTest/schema.sql @@ -0,0 +1,12 @@ +CREATE TABLE "PLUGINS"( + "UUID" CHARACTER VARYING(40) NOT NULL, + "KEE" CHARACTER VARYING(200) NOT NULL, + "BASE_PLUGIN_KEY" CHARACTER VARYING(200), + "FILE_HASH" CHARACTER VARYING(200) NOT NULL, + "CREATED_AT" BIGINT NOT NULL, + "UPDATED_AT" BIGINT NOT NULL, + "TYPE" CHARACTER VARYING(10) NOT NULL, + "REMOVED" BOOLEAN DEFAULT FALSE NOT NULL +); +ALTER TABLE "PLUGINS" ADD CONSTRAINT "PK_PLUGINS" PRIMARY KEY("UUID"); +CREATE UNIQUE INDEX "PLUGINS_KEY" ON "PLUGINS"("KEE" NULLS FIRST); -- 2.39.5