HAWKULAR-171 - Added Liquibase for database migration

hawkular · Apr 30, 2015 · aaae068 · aaae068
1 parent 23b56c3
commit aaae068
Show file tree

Hide file tree

Showing 8 changed files with 265 additions and 11 deletions.
diff --git a/accounts/pom.xml b/accounts/pom.xml
@@ -68,6 +68,16 @@
       <artifactId>cdi-api</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jboss.spec.javax.servlet</groupId>
+      <artifactId>jboss-servlet-api_3.1_spec</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jboss.spec.javax.transaction</groupId>
+      <artifactId>jboss-transaction-api_1.2_spec</artifactId>
+      <scope>provided</scope>
+    </dependency>
     <dependency>
       <groupId>org.jboss.spec.javax.ejb</groupId>
       <artifactId>jboss-ejb-api_3.2_spec</artifactId>
@@ -92,6 +102,14 @@
       <artifactId>jboss-logging-processor</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.liquibase</groupId>
+      <artifactId>liquibase-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.mattbertolini</groupId>
+      <artifactId>liquibase-slf4j</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>junit</groupId>

diff --git a/accounts/src/main/java/org/hawkular/accounts/backend/control/MsgLogger.java b/accounts/src/main/java/org/hawkular/accounts/backend/control/MsgLogger.java
@@ -38,4 +38,12 @@ public interface MsgLogger {
     @LogMessage(level = Logger.Level.INFO)
     @Message(id = 110001, value = "Finished setting up Hawkular Accounts")
     void infoFinishedSetupAccounts();
+
+    @LogMessage(level = Logger.Level.INFO)
+    @Message(id = 110002, value = "Starting database update")
+    void infoStartedDatabaseUpdated();
+
+    @LogMessage(level = Logger.Level.INFO)
+    @Message(id = 110003, value = "Finished database update")
+    void infoFinishedDatabaseUpdate();
 }
diff --git a/accounts/src/main/java/org/hawkular/accounts/backend/control/SetupHawkularAccountsImpl.java b/accounts/src/main/java/org/hawkular/accounts/backend/control/SetupHawkularAccountsImpl.java
@@ -21,12 +21,14 @@
 import org.hawkular.accounts.api.internal.adapter.HawkularAccounts;
 import org.hawkular.accounts.api.model.Role;
 
-import javax.annotation.PostConstruct;
-import javax.annotation.security.PermitAll;
+import javax.annotation.Resource;
 import javax.ejb.Singleton;
-import javax.ejb.Startup;
 import javax.inject.Inject;
 import javax.persistence.EntityManager;
+import javax.servlet.ServletContextEvent;
+import javax.servlet.ServletContextListener;
+import javax.transaction.SystemException;
+import javax.transaction.UserTransaction;
 import java.util.HashSet;
 import java.util.Set;
 
@@ -36,10 +38,7 @@
  *
  * @author Juraci Paixão Kröhling
  */
-@Startup
-@Singleton
-@PermitAll
-public class SetupHawkularAccountsImpl {
+public class SetupHawkularAccountsImpl implements ServletContextListener {
     private final MsgLogger logger = MsgLogger.LOGGER;
 
     @Inject
@@ -52,9 +51,32 @@ public class SetupHawkularAccountsImpl {
     @Inject
     OperationService operationService;
 
+    @Resource
+    UserTransaction tx;
+
     Set<Role> roles = new HashSet<>(7);
 
-    @PostConstruct
+    @Override
+    public void contextInitialized(ServletContextEvent servletContextEvent) throws RuntimeException {
+        try {
+            tx.begin();
+            setup();
+            tx.commit();
+        } catch (Exception e) {
+            try {
+                tx.rollback();
+            } catch (SystemException e1) {
+                // couldn't rollback... but let's ignore this one, as we've got another more important exception to log
+            }
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    public void contextDestroyed(ServletContextEvent servletContextEvent) {
+
+    }
+
     public void setup() {
         logger.infoStartedSetupAccounts();
         roles.add(monitor);

diff --git a/accounts/src/main/resources/org/hawkular/accounts/db/db.changelog-1.0.xml b/accounts/src/main/resources/org/hawkular/accounts/db/db.changelog-1.0.xml
@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright 2015 Red Hat, Inc. and/or its affiliates
+    and other contributors as indicated by the @author tags.
+
+    Licensed 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.
+
+-->
+<databaseChangeLog
+    xmlns="http://www.liquibase.org/xml/ns/dbchangelog/1.9"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog/1.9
+                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-1.9.xsd">
+
+  <changeSet author="jpkroehling" id="changelog-1.0">
+
+    <createTable tableName="Member">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+    </createTable>
+
+    <createTable tableName="Persona">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true" foreignKeyName="fk_persona_member_id" references="Member(id)"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="HawkularUser">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true" foreignKeyName="fk_user_id_persona_id" references="Persona(id)"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="Organization">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true" foreignKeyName="fk_organization_id_persona_id" references="Persona(id)"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="owner_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_organization_owner_persona_id" references="Persona(id)"/>
+      </column>
+      <column name="name" type="varchar(255)"/>
+      <column name="description" type="text"/>
+    </createTable>
+
+    <createTable tableName="Resource">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="parent_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_resource_parent_resource_id" references="Resource(id)"/>
+      </column>
+      <column name="persona_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_resource_persona_id" references="Persona(id)"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="Role">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="name" type="varchar(255)">
+        <constraints unique="true"/>
+      </column>
+      <column name="description" type="text"/>
+    </createTable>
+
+    <createTable tableName="Operation">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="name" type="varchar(255)">
+        <constraints unique="true"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="OrganizationMembership">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="member_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_orgmembership_member_member_id" references="Member(id)"/>
+      </column>
+      <column name="organization_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_orgmembership_organization_organization_id" references="Organization(id)"/>
+      </column>
+      <column name="role_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_orgmembership_role_role_id" references="Role(id)"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="Permission">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="operation_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_permission_operation_operation_id" references="Operation(id)"/>
+      </column>
+      <column name="role_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_permission_role_role_id" references="Role(id)"/>
+      </column>
+    </createTable>
+
+    <createTable tableName="PersonaResourceRole">
+      <column name="id" type="varchar(255)">
+        <constraints primaryKey="true"/>
+      </column>
+      <column name="createdAt" type="timestamp"/>
+      <column name="updatedAt" type="timestamp"/>
+      <column name="persona_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_prr_persona_id" references="Persona(id)"/>
+      </column>
+      <column name="resource_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_prr_resource_id" references="Resource(id)"/>
+      </column>
+      <column name="role_id" type="varchar(255)">
+        <constraints foreignKeyName="fk_prr_role_id" references="Role(id)"/>
+      </column>
+    </createTable>
+
+  </changeSet>
+
+</databaseChangeLog>
diff --git a/accounts/src/main/resources/org/hawkular/accounts/db/db.changelog-master.xml b/accounts/src/main/resources/org/hawkular/accounts/db/db.changelog-master.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright 2015 Red Hat, Inc. and/or its affiliates
+    and other contributors as indicated by the @author tags.
+
+    Licensed 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.
+
+-->
+<databaseChangeLog
+    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">
+
+  <include file="org/hawkular/accounts/db/db.changelog-1.0.xml"/>
+</databaseChangeLog>
diff --git a/accounts/src/main/webapp/WEB-INF/web.xml b/accounts/src/main/webapp/WEB-INF/web.xml
@@ -23,6 +23,29 @@
          version="3.0">
   <display-name>Hawkular Accounts</display-name>
 
+  <context-param>
+    <param-name>liquibase.changelog</param-name>
+    <param-value>org/hawkular/accounts/db/db.changelog-master.xml</param-value>
+  </context-param>
+
+  <context-param>
+    <param-name>liquibase.datasource</param-name>
+    <param-value>java:jboss/datasources/HawkularDS</param-value>
+  </context-param>
+
+  <context-param>
+    <param-name>liquibase.onerror.fail</param-name>
+    <param-value>true</param-value>
+  </context-param>
+
+  <listener>
+    <listener-class>liquibase.integration.servlet.LiquibaseServletListener</listener-class>
+  </listener>
+
+  <listener>
+    <listener-class>org.hawkular.accounts.backend.control.SetupHawkularAccountsImpl</listener-class>
+  </listener>
+
   <security-constraint>
     <web-resource-collection>
       <web-resource-name>REST endpoints</web-resource-name>

diff --git a/api/src/main/resources/META-INF/persistence.xml b/api/src/main/resources/META-INF/persistence.xml
@@ -23,6 +23,7 @@
 http://java.sun.com/xml/ns/persistence
 http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
   <persistence-unit name="hawkular-accounts">
+    <!-- If you are changing the datasource name, you have to change it in other places as well! -->
     <jta-data-source>java:jboss/datasources/HawkularDS</jta-data-source>
     <class>org.hawkular.accounts.api.model.BaseEntity</class>
     <class>org.hawkular.accounts.api.model.HawkularUser</class>
@@ -35,8 +36,5 @@ http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
     <class>org.hawkular.accounts.api.model.PersonaResourceRole</class>
     <class>org.hawkular.accounts.api.model.Resource</class>
     <class>org.hawkular.accounts.api.model.Role</class>
-    <properties>
-      <property name="hibernate.hbm2ddl.auto" value="update"/>
-    </properties>
   </persistence-unit>
 </persistence>
diff --git a/pom.xml b/pom.xml
@@ -181,6 +181,16 @@
           </exclusion>
         </exclusions>
       </dependency>
+      <dependency>
+        <groupId>org.liquibase</groupId>
+        <artifactId>liquibase-core</artifactId>
+        <version>3.3.3</version>
+      </dependency>
+      <dependency>
+        <groupId>com.mattbertolini</groupId>
+        <artifactId>liquibase-slf4j</artifactId>
+        <version>1.2.1</version>
+      </dependency>
 
       <dependency>
         <groupId>com.h2database</groupId>