import org.splat.dal.bo.som.Document;
import org.splat.dal.bo.som.DocumentType;
import org.splat.dal.bo.som.KnowledgeElementType;
+import org.splat.dal.bo.som.ProjectElement;
import org.splat.dal.bo.som.Publication;
import org.splat.dal.bo.som.Scenario;
import org.splat.dal.bo.som.SimulationContext;
import org.splat.dal.bo.som.Study;
import org.splat.dal.bo.som.UsedByRelation;
import org.splat.dal.bo.som.UsesRelation;
+import org.splat.dal.bo.som.ValidationCycle;
+import org.splat.dal.bo.som.ValidationCycleRelation;
+import org.splat.dal.bo.som.ValidationStep;
import org.splat.dal.bo.som.Document.Properties;
import org.splat.dal.dao.kernel.UserDAO;
import org.splat.dal.dao.som.Database;
import org.splat.dal.dao.som.ScenarioDAO;
+import org.splat.dal.dao.som.StudyDAO;
+import org.splat.dal.dao.som.ValidationCycleDAO;
import org.splat.exception.BusinessException;
+import org.splat.exception.InvalidParameterException;
import org.splat.i18n.I18nUtils;
import org.splat.kernel.InvalidPropertyException;
import org.splat.kernel.MismatchException;
import org.splat.log.AppLogger;
import org.splat.service.DocumentTypeService;
import org.splat.service.KnowledgeElementTypeService;
+import org.splat.service.ProjectElementService;
import org.splat.service.PublicationService;
import org.splat.service.ScenarioService;
import org.splat.service.SimulationContextService;
import org.splat.service.StudyService;
import org.splat.service.dto.DocumentDTO;
import org.splat.service.dto.FileDTO;
+import org.splat.service.dto.ScenarioDTO;
import org.splat.service.dto.StepDTO;
import org.splat.service.technical.ProjectSettingsService;
import org.splat.service.technical.RepositoryService;
@Qualifier("studyService")
private transient StudyService _studyService;
+ /**
+ * The StudyDAO. Later injected by Spring.
+ */
+ @Autowired
+ @Qualifier("studyDAO")
+ private transient StudyDAO _studyDAO;
+
+ /**
+ * The ValidationCycleDAO. Later injected by Spring.
+ */
+ @Autowired
+ @Qualifier("validationCycleDAO")
+ private transient ValidationCycleDAO _validationCycleDAO;
+
+ /**
+ * The ProjectElementService. Later injected by Spring.
+ */
+ @Autowired
+ @Qualifier("projectElementService")
+ private transient ProjectElementService _projectElementService;
+
/**
* Test of getting a scenario content for building siman-salome.conf.<BR>
* <B>Description :</B> <BR>
return new FileDTO(filePath);
}
+ /**
+ * Create a file.
+ *
+ * @param fname
+ * file name
+ * @throws IOException
+ * if file creation failed
+ */
+ private void createFile(final String fname) throws IOException {
+ // Create a file in the download directory
+ LOG.debug("Create file: " + fname);
+ String filePath = fname;
+ FileWriter fw = new FileWriter(filePath);
+ fw.write("Simulation of " + fname + " data file at " + new Date());
+ fw.close();
+ }
+
/**
* Get path to the user's downloads directory. The directory is created if it is not exist yet.
*
LOG.debug(">>>>> END testCreateStudyFromPython()");
}
+ /**
+ * Test study content copy.<BR>
+ * <B>Description :</B> <BR>
+ * <i>Create a study.</i><BR>
+ * <B>Action : </B><BR>
+ * <i>1. call the method for a not existing source study.</i><BR>
+ * <i>2. call the method for a not existing source scenario with not evolving step.</i><BR>
+ * <i>3. call the method for a not existing source scenario with evolving step.</i><BR>
+ * <i>4. call the method for an existing source scenario with evolving step.</i><BR>
+ * <B>Test data : </B><BR>
+ * <i>no input parameters</i><BR>
+ *
+ * <B>Outcome results:</B><BR>
+ * <i>
+ * <ul>
+ * <li>1: Exception must be thrown.</li>
+ * <li>2: The study content must be copied.</li>
+ * <li>3: Exception must be thrown.</li>
+ * <li>4: The study content must be copied.</li>
+ * </ul>
+ * </i>
+ *
+ * @throws IOException
+ * if application configuration loading is failed
+ * @throws SQLException
+ * if application configuration loading is failed
+ * @throws BusinessException
+ * if test data creation is failed
+ */
+ @Test(groups = { "study", "sevice", "functional", "business" })
+ public void testCopyStudyContent() throws IOException, SQLException,
+ BusinessException {
+ LOG.debug(">>>>> BEGIN testCopyStudyContent()");
+ startNestedTransaction();
+
+ HibernateTemplate ht = getHibernateTemplate();
+
+ Database.getInstance().reset();
+ _projectSettings.getAllSteps().clear(); // Clear config to be able to load it again
+ _projectSettings.configure("classpath:test/som.xml");
+
+ User goodUser = TestEntitiesGenerator.getTestUser("GoodUser");
+ _userDAO.create(goodUser);
+ User otherUser = TestEntitiesGenerator.getTestUser("otherUser");
+ _userDAO.create(otherUser);
+
+ // Create private study
+ Study aStudy = TestEntitiesGenerator.getTestStudy(goodUser);
+ aStudy.setTitle("0.This is private study");
+ Long studyId = _studyDAO.create(aStudy);
+
+ // Add a scenario to the study
+ Scenario scen = TestEntitiesGenerator.getTestScenario(aStudy);
+ _scenarioDAO.create(scen);
+ ht.flush();
+ // Add a second scenario to the study
+ scen = TestEntitiesGenerator.getTestScenario(aStudy);
+ Long aScenId = _scenarioDAO.create(scen);
+ ht.flush();
+
+ // Add a validation cycle with otherUser as a reviewer
+ ValidationCycle.Properties vprop = new ValidationCycle.Properties();
+ DocumentType dtype = _documentTypeService.selectType("minutes");
+ vprop.setDocumentType(dtype);
+ vprop.setActor(ValidationStep.REVIEW, otherUser);
+ ValidationCycle cycle = new ValidationCycle(aStudy, vprop);
+ _validationCycleDAO.create(cycle);
+ ValidationCycleRelation link = cycle.getContext();
+ aStudy.addRelation(link);
+ ht.flush();
+
+ // Add documents to the first study activity
+ // Add a converts relations
+ Map<Integer, org.splat.som.Step> stSteps = _projectElementService
+ .getStepsMap(aStudy);
+ org.splat.som.Step aStep = stSteps.get(1);
+ Publication pub1 = addDoc(aStudy, aStep, "document1", dtype);
+ Publication pub2 = addDoc(aStudy, aStep, "document2", dtype);
+ Publication pub3 = addDoc(aStudy, aStep, "document3", dtype);
+ ht.flush();
+
+ LOG.debug("pub1 version doc: " + pub1.value().getTitle() + " ["
+ + pub1.value().getReference() + "]" + " ["
+ + pub1.value().getRid() + "]");
+ LOG.debug("pub2 version doc: " + pub2.value().getTitle() + " ["
+ + pub2.value().getReference() + "]" + " ["
+ + pub2.value().getRid() + "]");
+ LOG.debug("pub3 version doc: " + pub3.value().getTitle() + " ["
+ + pub3.value().getReference() + "]" + " ["
+ + pub3.value().getRid() + "]");
+
+ ht.update(aStudy);
+
+ ht.flush();
+ LOG.debug("Before versioning:");
+ for (Publication doc : _projectElementService.getFirstStep(aStudy)
+ .getAllDocuments()) {
+ LOG.debug("Study doc: " + doc.value().getTitle() + " ["
+ + doc.value().getReference() + "]" + " ["
+ + doc.value().getRid() + "]");
+ }
+ // // Add a version relations
+ // Publication pub31 = version(pub3);
+ //
+ // LOG.debug("pub31 version doc: " + pub31.value().getTitle() + " ["
+ // + pub31.value().getReference() + "]" + " ["
+ // + pub31.value().getRid() + "]");
+ // ht.saveOrUpdate(aStudy);
+
+ // LOG.debug("After versioning:");
+ // for (Publication doc : aStudy.getDocums()) {
+ // LOG.debug("Study doc: " + doc.value().getTitle() + " ["
+ // + doc.value().getReference() + "]" + " ["
+ // + doc.value().getRid() + "]");
+ // }
+
+ // Add documents to the first scenario activity
+ Map<Integer, org.splat.som.Step> scSteps = _projectElementService
+ .getStepsMap(scen);
+ aStep = scSteps.get(2);
+ Publication spub1 = addDoc(scen, aStep, "sdocument1", dtype);
+ Publication spub2 = addDoc(scen, aStep, "sdocument2", dtype);
+ Publication spub3 = addDoc(scen, aStep, "sdocument3", dtype);
+ LOG.debug("spub1 version doc: " + spub1.value().getTitle() + " ["
+ + spub1.value().getReference() + "]" + " ["
+ + spub1.value().getRid() + "]");
+ LOG.debug("spub2 version doc: " + spub2.value().getTitle() + " ["
+ + spub2.value().getReference() + "]" + " ["
+ + spub2.value().getRid() + "]");
+ LOG.debug("spub3 version doc: " + spub3.value().getTitle() + " ["
+ + spub3.value().getReference() + "]" + " ["
+ + spub3.value().getRid() + "]");
+ ht.flush();
+
+ // Create a scenario document version
+ // Publication spub31 = version(spub3);
+ // LOG.debug("spub31 version doc: " + spub31.value().getTitle() + " ["
+ // + spub31.value().getReference() + "]" + " ["
+ // + spub31.value().getRid() + "]");
+
+ // Add uses relations
+ pub2.addDependency(pub1);
+ ht.saveOrUpdate(pub2.value());
+ pub3.addDependency(pub2);
+ ht.saveOrUpdate(pub3.value());
+
+ spub2.addDependency(pub1);
+ spub2.addDependency(spub1);
+ spub2.addDependency(pub2);
+ spub2.addDependency(pub3);
+ ht.saveOrUpdate(spub2.value());
+ spub3.addDependency(spub2);
+ ht.saveOrUpdate(spub3.value());
+ // spub31.addDependency(spub31);
+ // ht.saveOrUpdate(spub31.value());
+ ht.flush();
+
+ // Create target study1
+ Study aStudy1 = TestEntitiesGenerator.getTestStudy(goodUser);
+ aStudy1.setTitle("1.This is a target study1");
+ aStudy1.setReference("tst1");
+ Long studyId1 = _studyDAO.create(aStudy1);
+
+ // Add a scenario to the study
+ Scenario scen1 = TestEntitiesGenerator.getTestScenario(aStudy1);
+ _scenarioDAO.create(scen1);
+ ht.flush();
+
+ // Create target study2
+ Study aStudy2 = TestEntitiesGenerator.getTestStudy(goodUser);
+ aStudy2.setTitle("2.This is a target study2");
+ aStudy2.setReference("tst2");
+ Long studyId2 = _studyDAO.create(aStudy2);
+
+ // Add a scenario to the study
+ Scenario scen2 = TestEntitiesGenerator.getTestScenario(aStudy2);
+ _scenarioDAO.create(scen2);
+ ht.flush();
+ ht.clear();
+
+ // //////////////////// TEST CALL /////////////////////////////////////
+ // 1. call the method for a not existing source study.
+ try {
+ _scenarioService.copyStudyContent(-1, -1, -1, -1);
+ Assert.fail("Exception must be thrown for not existing study id.");
+ } catch (InvalidParameterException e) {
+ LOG.debug("Expected exception: " + e.getClass().getSimpleName()
+ + ": " + e.getMessage());
+ }
+
+ ht.flush();
+ ht.clear();
+
+ // 2. call the method for a not existing source scenario with not evolving step.
+ _scenarioService.copyStudyContent(studyId, -1, 1, studyId1);
+
+ ht.flush();
+ ht.clear();
+
+ aStudy = _studyService.selectStudy(studyId);
+ aStudy1 = _studyService.selectStudy(studyId1);
+ for (Publication pub : aStudy.getDocums()) {
+ // Find the same document in the created copy of the study
+ Publication found = null;
+ for (Publication newPub : aStudy1.getDocums()) {
+ if (pub.value().getTitle().equals(newPub.value().getTitle())
+ && pub.value().getType().equals(
+ newPub.value().getType())) {
+ found = newPub;
+ break;
+ }
+ }
+ Assert.assertNotNull(found, "The document "
+ + pub.value().getTitle() + "is not copied");
+ // Check that all files are copied (source and attached)
+ }
+
+ // 3. call the method for a not existing source scenario with evolving step.
+ try {
+ _scenarioService.copyStudyContent(studyId, -1, 2, studyId2);
+ Assert
+ .fail("Exception must be thrown for not existing scenario id and evolving step.");
+ } catch (InvalidParameterException e) {
+ LOG.debug("Expected exception: " + e.getClass().getSimpleName()
+ + ": " + e.getMessage());
+ }
+
+ ht.flush();
+ ht.clear();
+
+ // 4. call the method for an existing source scenario with evolving step.
+ _scenarioService.copyStudyContent(studyId, aScenId, 9, studyId2);
+ ht.flush();
+
+ rollbackNestedTransaction();
+ LOG.debug(">>>>> END testCopyStudyContent()");
+ }
+
+ /**
+ * Create a document and publish it in the project element.
+ *
+ * @param aProjElem
+ * the project element
+ * @param aStep
+ * the project element step
+ * @param docname
+ * document name
+ * @param dtype
+ * document type
+ * @return publication of the created document
+ * @throws BusinessException
+ * if document creation is failed
+ * @throws IOException
+ * if file creation is failed
+ */
+ private Publication addDoc(final ProjectElement aProjElem,
+ final org.splat.som.Step aStep, final String docname,
+ final DocumentType dtype) throws BusinessException, IOException {
+ HibernateTemplate ht = getHibernateTemplate();
+ // Add documents to the study activity
+ Document.Properties dprop = new Document.Properties().setAuthor(
+ aProjElem.getAuthor()).setDate(new Date()).setName(docname)
+ .setType(dtype).setFormat("py");
+ dprop.setLocalPath(dprop.getName() + "." + dprop.getFormat());
+ dprop.setStep(aStep.getStep());
+ Publication pub = _stepService.createDocument(aStep, dprop);
+ pub.setStep(aStep);
+ aProjElem.add(pub);
+ aStep.getDocuments().add(pub);
+ ht.saveOrUpdate(pub);
+ ht.save(pub.value());
+ // Add a converts relation
+ // Attach a med file
+ ht.saveOrUpdate(_publicationService.attach(pub, "med"));
+ String filepath = pub.getSourceFile().asFile().getAbsolutePath();
+ createFile(filepath);
+ createFile(filepath.substring(0, filepath.lastIndexOf(".")) + ".med");
+ return pub;
+ }
+
+ /**
+ * Create a new version of the document.
+ *
+ * @param pub
+ * the current document publication
+ * @return the new document version publication
+ * @throws IOException
+ * if versioning is failed
+ * @throws BusinessException
+ * if versioning is failed
+ */
+ private Publication version(final Publication pub)
+ throws BusinessException, IOException {
+ Document.Properties dprop = new Document.Properties();
+ dprop.setDocument(pub.value(), pub.getStep().getStep());
+ Publication newpub = _stepService.versionDocument(pub.getStep(), pub,
+ dprop);
+ pub.getOwner().getDocums().remove(pub);
+ pub.getStep().getDocuments().remove(pub);
+ pub.getOwner().add(newpub);
+ pub.getStep().getDocuments().add(newpub);
+ return newpub;
+ }
+
/**
* Test assigning a simulation context to a study.<BR>
* <B>Description :</B> <BR>
LOG.debug(">>>>> END testAssignStudyContextFromPython()");
}
+ /**
+ * Test getting a study scenarios DTO list.<BR>
+ * <B>Description :</B> <BR>
+ * <i>Create a study and get its scenarios DTO list.</i><BR>
+ * <B>Action : </B><BR>
+ * <i>1. call the method for not existing study id.</i><BR>
+ * <i>2. call the method for a study with one scenario.</i><BR>
+ * <i>3. call the method for a study with several scenarios.</i><BR>
+ * <B>Test data : </B><BR>
+ * <i>no input parameters</i><BR>
+ *
+ * <B>Outcome results:</B><BR>
+ * <i>
+ * <ul>
+ * <li>1: The returned list of DTO must be empty.</li>
+ * <li>2: The returned list of DTO must contain one scenario DTO.</li>
+ * <li>3: The returned list of DTO must contain several scenario DTOs.</li>
+ * </ul>
+ * </i>
+ *
+ * @throws IOException
+ * if application configuration loading is failed
+ * @throws SQLException
+ * if application configuration loading is failed
+ * @throws BusinessException
+ * if test data creation is failed
+ */
+ @Test(groups = { "study", "sevice", "functional", "business" })
+ public void testGetStudyScenarios() throws IOException, SQLException,
+ BusinessException {
+ LOG.debug(">>>>> BEGIN testGetStudyScenarios()");
+ startNestedTransaction();
+
+ HibernateTemplate ht = getHibernateTemplate();
+
+ Database.getInstance().reset();
+ _projectSettings.getAllSteps().clear(); // Clear config to be able to load it again
+ _projectSettings.configure("classpath:test/som.xml");
+
+ // Create a test user
+ User goodUser = TestEntitiesGenerator.getTestUser("goodUser");
+ _userDAO.create(goodUser);
+ Study study = TestEntitiesGenerator.getTestStudy(goodUser);
+ long studyId1 = _studyDAO.create(study);
+ ht.flush();
+ Scenario scen = TestEntitiesGenerator.getTestScenario(study,
+ "test scen11");
+ long id11 = _scenarioDAO.create(scen);
+ ht.flush();
+ study = TestEntitiesGenerator.getTestStudy(goodUser);
+ long studyId2 = _studyDAO.create(study);
+ ht.flush();
+ scen = TestEntitiesGenerator.getTestScenario(study, "test scen21");
+ long id21 = _scenarioDAO.create(scen);
+ ht.flush();
+ scen = TestEntitiesGenerator.getTestScenario(study, "test scen22");
+ long id22 = _scenarioDAO.create(scen);
+ ht.flush();
+ scen = TestEntitiesGenerator.getTestScenario(study, "test scen23");
+ long id23 = _scenarioDAO.create(scen);
+ ht.flush();
+ ht.clear();
+
+ // //////// START OF TESTS
+ // 1. call the method for not existing study id.
+ List<ScenarioDTO> scens = _scenarioService.getStudyScenarios(-1L);
+
+ Assert.assertNotNull(scens);
+ Assert.assertTrue(scens.isEmpty());
+
+ // 2. call the method for a study with one scenario.
+ scens = _scenarioService.getStudyScenarios(studyId1);
+
+ ht.flush();
+ ht.clear();
+ Assert.assertNotNull(scens);
+ Assert.assertEquals(scens.size(), 1);
+ Assert.assertEquals(scens.get(0).getIndex().longValue(), id11);
+ Assert.assertEquals(scens.get(0).getTitle(), "test scen11");
+
+ // 3. call the method for a study with several scenarios.
+ scens = _scenarioService.getStudyScenarios(studyId2);
+ Assert.assertEquals(scens.size(), 3);
+ Assert.assertEquals(scens.get(0).getIndex().longValue(), id21);
+ Assert.assertEquals(scens.get(0).getTitle(), "test scen21");
+ Assert.assertEquals(scens.get(1).getIndex().longValue(), id22);
+ Assert.assertEquals(scens.get(1).getTitle(), "test scen22");
+ Assert.assertEquals(scens.get(2).getIndex().longValue(), id23);
+ Assert.assertEquals(scens.get(2).getTitle(), "test scen23");
+
+ ht.flush();
+ ht.clear();
+
+ rollbackNestedTransaction();
+ LOG.debug(">>>>> END testGetStudyScenarios()");
+ }
+
/**
* Check if the context is assigned to the study.
*
