add the server-side component ServerUpgradeStatus to know the database version before starting the server

3 files changed, 135 insertions, 2 deletions

diff --git a/sonar-server/src/main/java/org/sonar/server/platform/DefaultServerUpgradeStatus.java b/sonar-server/src/main/java/org/sonar/server/platform/DefaultServerUpgradeStatus.java
new file mode 100644
index 00000000000..545f2c336f7
--- /dev/null
+++ b/sonar-server/src/main/java/org/sonar/server/platform/DefaultServerUpgradeStatus.java
@@ -0,0 +1,60 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.server.platform;
+
+import org.apache.commons.lang.builder.ReflectionToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+import org.sonar.api.platform.ServerUpgradeStatus;
+import org.sonar.jpa.entity.SchemaMigration;
+import org.sonar.jpa.session.DatabaseConnector;
+
+/**
+ * @since 2.5
+ */
+public final class DefaultServerUpgradeStatus implements ServerUpgradeStatus {
+
+  private int initialDbVersion;
+  private DatabaseConnector dbConnector;
+
+  public DefaultServerUpgradeStatus(DatabaseConnector dbConnector) {
+    this.dbConnector = dbConnector;
+  }
+
+  public void start() {
+    this.initialDbVersion = dbConnector.getDatabaseVersion();
+  }
+
+  public boolean isUpgraded() {
+    return !isInstalledFromScratch() &&(initialDbVersion < SchemaMigration.LAST_VERSION);
+  }
+
+  public boolean isInstalledFromScratch() {
+    return initialDbVersion <= 0;
+  }
+
+  public int getInitialDbVersion() {
+    return initialDbVersion;
+  }
+
+  @Override
+  public String toString() {
+    return new ReflectionToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).toString();
+  }
+}
diff --git a/sonar-server/src/main/java/org/sonar/server/platform/Platform.java b/sonar-server/src/main/java/org/sonar/server/platform/Platform.java
index bd25a77c12a..302ff2a2fc7 100644
--- a/sonar-server/src/main/java/org/sonar/server/platform/Platform.java
+++ b/sonar-server/src/main/java/org/sonar/server/platform/Platform.java
@@ -28,6 +28,7 @@ import org.sonar.api.Plugins;
 import org.sonar.api.database.configuration.DatabaseConfiguration;
 import org.sonar.api.platform.Environment;
 import org.sonar.api.platform.Server;
+import org.sonar.api.platform.ServerUpgradeStatus;
 import org.sonar.api.profiles.AnnotationProfileParser;
 import org.sonar.api.profiles.XMLProfileParser;
 import org.sonar.api.profiles.XMLProfileSerializer;
@@ -96,7 +97,7 @@ public final class Platform {
   }
 
   public void start() {
-    if (!started && isConnectedToDatabase()) {
+    if (!started && isUpToDateDatabase()) {
       TimeProfiler profiler = new TimeProfiler().start("Start services");
       startCoreComponents();
       startServiceComponents();
@@ -113,12 +114,13 @@ public final class Platform {
     rootContainer.as(Characteristics.CACHE).addComponent(configuration);
     rootContainer.as(Characteristics.CACHE).addComponent(EmbeddedDatabaseFactory.class);
     rootContainer.as(Characteristics.CACHE).addComponent(JndiDatabaseConnector.class);
+    rootContainer.as(Characteristics.CACHE).addComponent(DefaultServerUpgradeStatus.class);
     rootContainer.start();
 
     // Platform is already starting, so it's registered after the container startup
   }
 
-  private boolean isConnectedToDatabase() {
+  private boolean isUpToDateDatabase() {
     JndiDatabaseConnector databaseConnector = getContainer().getComponent(JndiDatabaseConnector.class);
     return databaseConnector.isOperational();
   }
diff --git a/sonar-server/src/test/java/org/sonar/server/platform/DefaultServerUpgradeStatusTest.java b/sonar-server/src/test/java/org/sonar/server/platform/DefaultServerUpgradeStatusTest.java
new file mode 100644
index 00000000000..be801d2ac83
--- /dev/null
+++ b/sonar-server/src/test/java/org/sonar/server/platform/DefaultServerUpgradeStatusTest.java
@@ -0,0 +1,71 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.server.platform;
+
+import org.junit.Test;
+import org.sonar.jpa.entity.SchemaMigration;
+import org.sonar.jpa.session.DatabaseConnector;
+
+import static org.hamcrest.core.Is.is;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class DefaultServerUpgradeStatusTest {
+
+  @Test
+  public void shouldBeInstalledFromScratch() {
+    DatabaseConnector connector = mock(DatabaseConnector.class);
+    when(connector.getDatabaseVersion()).thenReturn(-1);
+
+    DefaultServerUpgradeStatus status = new DefaultServerUpgradeStatus(connector);
+    status.start();
+
+    assertThat(status.isInstalledFromScratch(), is(true));
+    assertThat(status.isUpgraded(), is(false));
+    assertThat(status.getInitialDbVersion(), is(-1));
+  }
+
+  @Test
+  public void shouldBeUpgraded() {
+    DatabaseConnector connector = mock(DatabaseConnector.class);
+    when(connector.getDatabaseVersion()).thenReturn(50);
+
+    DefaultServerUpgradeStatus status = new DefaultServerUpgradeStatus(connector);
+    status.start();
+
+    assertThat(status.isInstalledFromScratch(), is(false));
+    assertThat(status.isUpgraded(), is(true));
+    assertThat(status.getInitialDbVersion(), is(50));
+  }
+
+  @Test
+  public void shouldNotBeUpgraded() {
+    DatabaseConnector connector = mock(DatabaseConnector.class);
+    when(connector.getDatabaseVersion()).thenReturn(SchemaMigration.LAST_VERSION);
+
+    DefaultServerUpgradeStatus status = new DefaultServerUpgradeStatus(connector);
+    status.start();
+    
+    assertThat(status.isInstalledFromScratch(), is(false));
+    assertThat(status.isUpgraded(), is(false));
+    assertThat(status.getInitialDbVersion(), is(SchemaMigration.LAST_VERSION));
+  }
+}