WIP - prepare test for optimize GetTransUnitListHandler to resolve hi…

…bernate n+1 query problem
zanata · Oct 19, 2012 · 3cc51d2 · 3cc51d2
1 parent c11c40c
commit 3cc51d2
Show file tree

Hide file tree

Showing 7 changed files with 399 additions and 2 deletions.
diff --git a/zanata-model/src/main/java/org/zanata/model/HDocument.java b/zanata-model/src/main/java/org/zanata/model/HDocument.java
@@ -227,7 +227,9 @@ public ContentType getContentType()
    public Map<String, HTextFlow> getAllTextFlows()
    {
       if (allTextFlows == null)
+      {
          allTextFlows = new HashMap<String, HTextFlow>();
+      }
       return allTextFlows;
    }
 
@@ -250,7 +252,9 @@ private void setAllTextFlows(Map<String, HTextFlow> allTextFlows)
    public List<HTextFlow> getTextFlows()
    {
       if (textFlows == null)
+      {
          textFlows = new ArrayList<HTextFlow>();
+      }
       return textFlows;
       // return ImmutableList.copyOf(textFlows);
    }
@@ -280,7 +284,9 @@ private void setPoTargetHeaders(Map<HLocale, HPoTargetHeader> poTargetHeaders)
    public Map<HLocale, HPoTargetHeader> getPoTargetHeaders()
    {
       if (poTargetHeaders == null)
+      {
          poTargetHeaders = new HashMap<HLocale, HPoTargetHeader>();
+      }
       return poTargetHeaders;
    }
 

diff --git a/zanata-war/src/test/java/org/zanata/DBUnitDataExtractor.java b/zanata-war/src/test/java/org/zanata/DBUnitDataExtractor.java
@@ -0,0 +1,78 @@
+package org.zanata;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.util.AbstractMap;
+import java.util.List;
+import java.util.Map;
+
+import org.dbunit.database.DatabaseConnection;
+import org.dbunit.database.IDatabaseConnection;
+import org.dbunit.database.QueryDataSet;
+import org.dbunit.dataset.xml.FlatDtdDataSet;
+import org.dbunit.dataset.xml.FlatXmlDataSet;
+import org.testng.annotations.Test;
+
+import com.google.common.collect.Lists;
+
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * This class is used to extract data out of a real database and put it in DBUnit's xml format.
+ *
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+@Test(groups = "manual-tests")
+@Slf4j
+public class DBUnitDataExtractor
+{
+   private static final String TEMP_DIR = System.getProperty("java.io.tmpdir");
+
+   private void generateTestData(String dataSetName, List<Map.Entry<String, String>> tableNameToQueryMap) throws Exception
+   {
+      Class.forName("com.mysql.jdbc.Driver");
+      Connection jdbcConnection = DriverManager.getConnection("jdbc:mysql://localhost:3306/zanata", "root", "");
+      IDatabaseConnection connection = new DatabaseConnection(jdbcConnection);
+
+      QueryDataSet dataSet = new QueryDataSet(connection);
+
+      for (Map.Entry<String, String> entry : tableNameToQueryMap)
+      {
+         dataSet.addTable(entry.getKey(), entry.getValue());
+      }
+
+      log.info("+++++ writing DBUnit data set to : {}", TEMP_DIR);
+      FlatDtdDataSet.write(dataSet, new FileOutputStream(new File(TEMP_DIR, dataSetName + ".dbunit.dtd")));
+      FlatXmlDataSet.write(dataSet, new FileOutputStream(new File(TEMP_DIR, dataSetName + ".dbunit.xml")));
+
+      jdbcConnection.close();
+   }
+
+   @Test
+   public void run() throws Exception
+   {
+      List<Map.Entry<String, String>> tableNameAndQuery = Lists.newArrayList();
+
+      addEntry(tableNameAndQuery, "HAccount", "SELECT * FROM HAccount where id = 1");
+      addEntry(tableNameAndQuery, "HPerson", "SELECT * FROM HPerson where id = 1");
+      addEntry(tableNameAndQuery, "HLocale", "SELECT * FROM HLocale where id = 3 or id = 5");
+      addEntry(tableNameAndQuery, "HPoHeader", "SELECT * FROM HPoHeader where id = 1");
+      addEntry(tableNameAndQuery, "HProject", "SELECT * FROM HProject where id = 1");
+      addEntry(tableNameAndQuery, "HProjectIteration", "SELECT * FROM HProjectIteration where id = 1");
+      addEntry(tableNameAndQuery, "HDocument", "SELECT * FROM HDocument where id = 1");
+      addEntry(tableNameAndQuery, "HSimpleComment", "SELECT * FROM HSimpleComment where (id >=2 AND id <=11) or (id >=3947 AND id <= 3949)");
+      addEntry(tableNameAndQuery, "HPotEntryData", "SELECT * FROM HPotEntryData where id >= 1 AND id <=10");
+      addEntry(tableNameAndQuery, "HTextFlow", "SELECT * FROM HTextFlow where document_id = 1 AND pos < 10");
+      addEntry(tableNameAndQuery, "HTextFlowTarget", "SELECT * FROM HTextFlowTarget where tf_id >= 1 AND tf_id <= 10 AND locale = 3");
+
+      generateTestData("GetTransUnitListHandlerPerformanceTest", tableNameAndQuery);
+   }
+
+   private static void addEntry(List<Map.Entry<String, String>> tableNameAndQuery, String table, String query)
+   {
+      tableNameAndQuery.add(new AbstractMap.SimpleEntry<String, String>(table, query));
+   }
+
+}
diff --git a/zanata-war/src/test/java/org/zanata/webtrans/server/rpc/GetTransUnitListHandlerTest.java b/zanata-war/src/test/java/org/zanata/webtrans/server/rpc/GetTransUnitListHandlerTest.java
@@ -0,0 +1,92 @@
+package org.zanata.webtrans.server.rpc;
+
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.sql.Connection;
+import java.sql.DriverManager;
+
+import org.dbunit.database.DatabaseConnection;
+import org.dbunit.database.IDatabaseConnection;
+import org.dbunit.database.QueryDataSet;
+import org.dbunit.dataset.xml.FlatDtdDataSet;
+import org.dbunit.dataset.xml.FlatXmlDataSet;
+import org.dbunit.operation.DatabaseOperation;
+import org.hibernate.Session;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+import org.zanata.ZanataDbunitJpaTest;
+import org.zanata.common.LocaleId;
+import org.zanata.dao.TextFlowDAO;
+import org.zanata.model.HLocale;
+import org.zanata.model.TestFixture;
+import org.zanata.rest.service.ResourceUtils;
+import org.zanata.seam.SeamAutowire;
+import org.zanata.security.ZanataIdentity;
+import org.zanata.service.LocaleService;
+import org.zanata.service.TextFlowSearchService;
+import org.zanata.webtrans.client.service.GetTransUnitActionContext;
+import org.zanata.webtrans.shared.auth.EditorClientId;
+import org.zanata.webtrans.shared.model.DocumentId;
+import org.zanata.webtrans.shared.model.ProjectIterationId;
+import org.zanata.webtrans.shared.rpc.GetTransUnitList;
+import org.zanata.webtrans.shared.rpc.GetTransUnitListResult;
+
+import lombok.extern.slf4j.Slf4j;
+import static org.mockito.Mockito.*;
+import static org.mockito.Mockito.when;
+
+/**
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+@Test(groups = { "jpa-tests" })
+@Slf4j
+public class GetTransUnitListHandlerTest extends ZanataDbunitJpaTest
+{
+   private GetTransUnitListHandler handler;
+   @Mock
+   private ZanataIdentity identity;
+   @Mock
+   private LocaleService localeService;
+   @Mock
+   private TextFlowSearchService textFlowSearchServiceImpl;
+
+   @Override
+   protected void prepareDBUnitOperations()
+   {
+      beforeTestOperations.add(new DataSetOperation("performance/GetTransUnitListHandlerPerformanceTest.dbunit.xml", DatabaseOperation.CLEAN_INSERT));
+   }
+
+   @BeforeMethod
+   public void setUp() throws Exception
+   {
+      MockitoAnnotations.initMocks(this);
+      TextFlowDAO dao = new TextFlowDAO((Session) getEm().getDelegate());
+      TransUnitTransformer transUnitTransformer = SeamAutowire.instance().use("resourceUtils", new ResourceUtils()).autowire(TransUnitTransformer.class);
+      // @formatter:off
+      handler = SeamAutowire.instance()
+            .use("identity", identity)
+            .use("localeServiceImpl", localeService)
+            .use("textFlowDAO", dao)
+            .use("transUnitTransformer", transUnitTransformer)
+            .use("textFlowSearchServiceImpl", textFlowSearchServiceImpl)
+            .autowire(GetTransUnitListHandler.class);
+      // @formatter:on
+   }
+
+   @Test
+   public void testExecute() throws Exception
+   {
+      GetTransUnitList action = GetTransUnitList.newAction(new GetTransUnitActionContext(new DocumentId(1)));
+      action.setEditorClientId(new EditorClientId("sessionId", 1));
+      action.setWorkspaceId(TestFixture.workspaceId(new LocaleId("ja")));
+      HLocale jaLocale = getEm().find(HLocale.class, 3L);
+      ProjectIterationId projectIterationId = action.getWorkspaceId().getProjectIterationId();
+      when(localeService.validateLocaleByProjectIteration(action.getWorkspaceId().getLocaleId(), projectIterationId.getProjectSlug(), projectIterationId.getIterationSlug())).thenReturn(jaLocale);
+
+      GetTransUnitListResult result = handler.execute(action, null);
+
+      log.info("result: {}", result);
+   }
+}
diff --git a/...a-war/src/test/java/org/zanata/webtrans/server/rpc/RevertTransUnitUpdatesHandlerTest.java b/...a-war/src/test/java/org/zanata/webtrans/server/rpc/RevertTransUnitUpdatesHandlerTest.java
@@ -42,7 +42,6 @@ public class RevertTransUnitUpdatesHandlerTest
    private RevertTransUnitUpdatesHandler handler;
    @Mock
    private TranslationService translationServiceImpl;
-   private TransUnitTransformer transUnitTransformer;
    @Mock
    private SecurityService securityServiceImpl;
    @Mock
@@ -56,7 +55,7 @@ public class RevertTransUnitUpdatesHandlerTest
    public void setUp() throws Exception
    {
       MockitoAnnotations.initMocks(this);
-      transUnitTransformer = SeamAutowire.instance().use("resourceUtils", new ResourceUtils()).autowire(TransUnitTransformer.class);
+      TransUnitTransformer transUnitTransformer = SeamAutowire.instance().use("resourceUtils", new ResourceUtils()).autowire(TransUnitTransformer.class);
       // @formatter:off
       handler = SeamAutowire.instance()
             .use("translationServiceImpl", translationServiceImpl)

diff --git a/zanata-war/src/test/resources/AllNonContainerTests.tng.xml b/zanata-war/src/test/resources/AllNonContainerTests.tng.xml
@@ -13,6 +13,7 @@
  			<run>
  				<include name=".*"/>
  				<exclude name="seam-tests"/>
+ 				<exclude name="manual-tests"/>
  			</run>
  		</groups>
  		<packages>

diff --git a/zanata-war/src/test/resources/performance/GetTransUnitListHandlerPerformanceTest.dbunit.dtd b/zanata-war/src/test/resources/performance/GetTransUnitListHandlerPerformanceTest.dbunit.dtd
@@ -0,0 +1,163 @@
+<!ELEMENT dataset (
+    HAccount*,
+    HPerson*,
+    HLocale*,
+    HPoHeader*,
+    HProject*,
+    HProjectIteration*,
+    HDocument*,
+    HSimpleComment*,
+    HPotEntryData*,
+    HTextFlow*,
+    HTextFlowTarget*)>
+
+<!ELEMENT HAccount EMPTY>
+<!ATTLIST HAccount
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    apiKey CDATA #IMPLIED
+    enabled CDATA #REQUIRED
+    passwordHash CDATA #IMPLIED
+    username CDATA #IMPLIED
+    mergedInto CDATA #IMPLIED
+>
+
+<!ELEMENT HPerson EMPTY>
+<!ATTLIST HPerson
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    email CDATA #REQUIRED
+    name CDATA #REQUIRED
+    accountId CDATA #IMPLIED
+>
+
+<!ELEMENT HLocale EMPTY>
+<!ATTLIST HLocale
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    active CDATA #REQUIRED
+    localeId CDATA #REQUIRED
+    enabledByDefault CDATA #IMPLIED
+>
+
+<!ELEMENT HPoHeader EMPTY>
+<!ATTLIST HPoHeader
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    entries CDATA #IMPLIED
+    comment_id CDATA #IMPLIED
+>
+
+<!ELEMENT HProject EMPTY>
+<!ATTLIST HProject
+    projecttype CDATA #REQUIRED
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    slug CDATA #REQUIRED
+    description CDATA #IMPLIED
+    homeContent CDATA #IMPLIED
+    name CDATA #REQUIRED
+    overrideLocales CDATA #REQUIRED
+    status CDATA #IMPLIED
+    restrictedByRoles CDATA #IMPLIED
+    default_copy_trans_opts_id CDATA #IMPLIED
+>
+
+<!ELEMENT HProjectIteration EMPTY>
+<!ATTLIST HProjectIteration
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    slug CDATA #REQUIRED
+    parentId CDATA #IMPLIED
+    project_id CDATA #REQUIRED
+    overrideLocales CDATA #REQUIRED
+    status CDATA #IMPLIED
+>
+
+<!ELEMENT HDocument EMPTY>
+<!ATTLIST HDocument
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    contentType CDATA #REQUIRED
+    docId CDATA #REQUIRED
+    name CDATA #REQUIRED
+    obsolete CDATA #REQUIRED
+    path CDATA #REQUIRED
+    revision CDATA #REQUIRED
+    last_modified_by_id CDATA #IMPLIED
+    locale CDATA #REQUIRED
+    poHeader_id CDATA #IMPLIED
+    project_iteration_id CDATA #REQUIRED
+>
+
+<!ELEMENT HSimpleComment EMPTY>
+<!ATTLIST HSimpleComment
+    id CDATA #REQUIRED
+    comment CDATA #REQUIRED
+>
+
+<!ELEMENT HPotEntryData EMPTY>
+<!ATTLIST HPotEntryData
+    id CDATA #REQUIRED
+    context CDATA #IMPLIED
+    flags CDATA #IMPLIED
+    refs CDATA #IMPLIED
+    comment_id CDATA #IMPLIED
+    tf_id CDATA #IMPLIED
+>
+
+<!ELEMENT HTextFlow EMPTY>
+<!ATTLIST HTextFlow
+    id CDATA #REQUIRED
+    obsolete CDATA #REQUIRED
+    pos CDATA #REQUIRED
+    resId CDATA #REQUIRED
+    revision CDATA #REQUIRED
+    comment_id CDATA #IMPLIED
+    document_id CDATA #REQUIRED
+    potEntryData_id CDATA #IMPLIED
+    wordCount CDATA #REQUIRED
+    contentHash CDATA #REQUIRED
+    plural CDATA #IMPLIED
+    content0 CDATA #IMPLIED
+    content1 CDATA #IMPLIED
+    content2 CDATA #IMPLIED
+    content3 CDATA #IMPLIED
+    content4 CDATA #IMPLIED
+    content5 CDATA #IMPLIED
+>
+
+<!ELEMENT HTextFlowTarget EMPTY>
+<!ATTLIST HTextFlowTarget
+    id CDATA #REQUIRED
+    creationDate CDATA #REQUIRED
+    lastChanged CDATA #REQUIRED
+    versionNum CDATA #REQUIRED
+    state CDATA #REQUIRED
+    tf_revision CDATA #REQUIRED
+    comment_id CDATA #IMPLIED
+    last_modified_by_id CDATA #IMPLIED
+    locale CDATA #REQUIRED
+    tf_id CDATA #IMPLIED
+    content0 CDATA #IMPLIED
+    content1 CDATA #IMPLIED
+    content2 CDATA #IMPLIED
+    content3 CDATA #IMPLIED
+    content4 CDATA #IMPLIED
+    content5 CDATA #IMPLIED
+>
+