SONAR-10409 Update too long keys of permission templates

server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v71/DbVersion71.java

@@ -34,6 +34,7 @@ public class DbVersion71 implements DbVersion {
       .add(2004, "Use rule id in QPROFILE_CHANGES", UseRuleIdInQPChangesData.class)
       .add(2005, "Create table DEPRECATED_RULE_KEYS", CreateDeprecatedRuleKeysTable.class)
       .add(2006, "Clean orphans in Compute Engine child tables", CleanCeChildTablesOrphans.class)
+      .add(2007, "Update PERMISSION_TEMPLATES.KEYS ", UpdatePermissionTooLongTemplateKeys.class)
     ;
   }
 }

server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v71/UpdatePermissionTooLongTemplateKeys.java

@@ -0,0 +1,67 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2018 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.v71;
+
+import java.sql.SQLException;
+import org.sonar.core.util.UuidFactory;
+import org.sonar.db.Database;
+import org.sonar.db.dialect.MsSql;
+import org.sonar.server.platform.db.migration.def.VarcharColumnDef;
+import org.sonar.server.platform.db.migration.step.DataChange;
+import org.sonar.server.platform.db.migration.step.MassUpdate;
+
+/**
+ * SONAR-10409
+ *
+ * Update keys of PERMISSION_TEMPLATES that are longer than 40 characters
+ */
+public class UpdatePermissionTooLongTemplateKeys extends DataChange {
+
+  private final String lengthFunction;
+  private final UuidFactory uuidFactory;
+
+  public UpdatePermissionTooLongTemplateKeys(Database db, UuidFactory uuidFactory) {
+    super(db);
+    this.uuidFactory = uuidFactory;
+    if (db.getDialect().getId().equals(MsSql.ID)) {
+      lengthFunction = "len";
+    } else {
+      lengthFunction = "length";
+    }
+  }
+
+  @Override
+  protected void execute(Context context) throws SQLException {
+    MassUpdate massUpdate = context.prepareMassUpdate();
+    massUpdate.select("select kee from permission_templates where " + lengthFunction + "(kee) > ?").setInt(1, VarcharColumnDef.UUID_SIZE);
+    massUpdate.update("update permission_templates set kee=? where kee=?");
+    massUpdate.rowPluralName("permission templates");
+
+    massUpdate.execute((row, update) -> {
+      String oldKey = row.getString(1);
+      String newKey = uuidFactory.create();
+
+      update.setString(1, newKey);
+      update.setString(2, oldKey);
+      return true;
+    });
+  }
+}

server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v71/DbVersion71Test.java

@@ -36,7 +36,7 @@ public class DbVersion71Test {
 
   @Test
   public void verify_migration_count() {
-    verifyMigrationCount(underTest, 7);
+    verifyMigrationCount(underTest, 8);
   }
 
 }

server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v71/UpdatePermissionTooLongTemplateKeysTest.java

@@ -0,0 +1,108 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2018 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.v71;
+
+import com.google.common.collect.ImmutableList;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Random;
+import java.util.stream.IntStream;
+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 static java.util.stream.Collectors.toList;
+import static org.apache.commons.lang.RandomStringUtils.randomAlphanumeric;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class UpdatePermissionTooLongTemplateKeysTest {
+  @Rule
+  public CoreDbTester dbTester = CoreDbTester.createForSchema(UpdatePermissionTooLongTemplateKeysTest.class, "templates.sql");
+
+  private static final Random RANDOM = new Random();
+
+  private final RecordingUuidFactory UUID_FACTORY = new RecordingUuidFactory();
+  private final UpdatePermissionTooLongTemplateKeys underTest = new UpdatePermissionTooLongTemplateKeys(dbTester.database(), UUID_FACTORY);
+
+  @Test
+  public void keys_whose_length_is_greater_than_40_should_be_updated() throws SQLException {
+    // Create 10 permission templates with keys' length greater or equals than 40
+    List<String> tooLongKeys = IntStream.range(0, 10)
+      .mapToObj(i -> insertTemplate(randomAlphanumeric(41 + RANDOM.nextInt(60))))
+      .collect(toList());
+
+    underTest.execute();
+
+    assertThat(UUID_FACTORY.getRecordedUuids()).hasSize(tooLongKeys.size());
+    List<String> kees = dbTester.select("select kee from permission_templates").stream()
+      .map(r -> (String) r.get("KEE")).collect(toList());
+
+    assertThat(kees).containsExactlyInAnyOrder(UUID_FACTORY.getRecordedUuids().toArray(new String[] {}));
+  }
+
+  @Test
+  public void keys_whose_length_is_lower_than_40_should_not_be_updated() throws SQLException {
+    // Create 10 permission templates with keys' length lower or equals than 40
+    List<String> correctKeys = IntStream.range(0, 10)
+      .mapToObj(i -> insertTemplate(randomAlphanumeric(RANDOM.nextInt(41))))
+      .collect(toList());
+
+    underTest.execute();
+
+    assertThat(UUID_FACTORY.getRecordedUuids()).hasSize(0);
+    List<String> kees = dbTester.select("select kee from permission_templates").stream()
+      .map(r -> (String) r.get("KEE")).collect(toList());
+
+    assertThat(kees).containsExactlyInAnyOrder(correctKeys.toArray(new String[] {}));
+  }
+
+  private String insertTemplate(String kee) {
+    dbTester.executeInsert(
+      "PERMISSION_TEMPLATES",
+      "NAME", randomAlphanumeric(50),
+      "ORGANIZATION_UUID", "uuid",
+      "KEE", kee);
+    return kee;
+  }
+
+  private static final class RecordingUuidFactory implements UuidFactory {
+    private final List<String> generatedUuids = new ArrayList<>();
+    private final UuidFactory uuidFactory = UuidFactoryFast.getInstance();
+
+    @Override
+    public String create() {
+      String uuid = uuidFactory.create();
+      generatedUuids.add(uuid);
+      return uuid;
+    }
+
+    public void clear() {
+      generatedUuids.clear();
+    }
+
+    public List<String> getRecordedUuids() {
+      return ImmutableList.copyOf(generatedUuids);
+    }
+  }
+}

server/sonar-db-migration/src/test/resources/org/sonar/server/platform/db/migration/version/v71/UpdatePermissionTooLongTemplateKeysTest/templates.sql

@@ -0,0 +1,10 @@
+CREATE TABLE "PERMISSION_TEMPLATES" (
+  "ID" INTEGER NOT NULL GENERATED BY DEFAULT AS IDENTITY (START WITH 1, INCREMENT BY 1),
+  "ORGANIZATION_UUID" VARCHAR(40) NOT NULL,
+  "NAME" VARCHAR(100) NOT NULL,
+  "KEE" VARCHAR(100) NOT NULL,
+  "DESCRIPTION" VARCHAR(4000),
+  "KEY_PATTERN" VARCHAR(500),
+  "CREATED_AT" TIMESTAMP,
+  "UPDATED_AT" TIMESTAMP
+);