Add stub for studies module

Author: bbimber

Studies/build.gradle

@@ -0,0 +1,13 @@
+plugins {
+    id 'org.labkey.build.module'
+}
+
+dependencies
+{
+    BuildUtils.addLabKeyDependency(project: project, config: "implementation", depProjectPath: ":server:modules:LabDevKitModules:laboratory", depProjectConfig: "apiJarFile")
+    BuildUtils.addLabKeyDependency(project: project, config: "implementation", depProjectPath: ":server:modules:LabDevKitModules:LDK", depProjectConfig: "apiJarFile")
+
+    BuildUtils.addLabKeyDependency(project: project, config: "modules", depProjectPath: ":server:modules:LabDevKitModules:laboratory", depProjectConfig: "published", depExtension: "module")
+    BuildUtils.addLabKeyDependency(project: project, config: "modules", depProjectPath: ":server:modules:LabDevKitModules:LDK", depProjectConfig: "published", depExtension: "module")
+}
+

Studies/module.properties

@@ -0,0 +1,5 @@
+ModuleClass: org.labkey.studies.StudiesModule
+Label: Studies
+Description: Extensions to the study framework, designed to more flexibly manage multiple study designs from one source of data
+License: Apache 2.0
+LicenseURL: http://www.apache.org/licenses/LICENSE-2.0

Studies/resources/schemas/dbscripts/postgresql/studies-0.00-23.000.sql

@@ -0,0 +1 @@
+CREATE SCHEMA studies;

Studies/resources/schemas/dbscripts/sqlserver/studies-0.00-23.000.sql

@@ -0,0 +1,2 @@
+CREATE SCHEMA studies;
+GO

Studies/resources/schemas/studies.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<tables xsi:schemaLocation="http://labkey.org/data/xml ..\..\..\..\schemas\tableInfo.xsd"
+        xmlns="http://labkey.org/data/xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

Studies/src/org/labkey/studies/StudiesController.java

@@ -0,0 +1,14 @@
+package org.labkey.studies;
+
+import org.labkey.api.action.SpringActionController;
+
+public class StudiesController extends SpringActionController
+{
+    private static final DefaultActionResolver _actionResolver = new DefaultActionResolver(StudiesController.class);
+    public static final String NAME = "studies";
+
+    public StudiesController()
+    {
+        setActionResolver(_actionResolver);
+    }
+}

Studies/src/org/labkey/studies/StudiesManager.java

@@ -0,0 +1,16 @@
+package org.labkey.studies;
+
+public class StudiesManager
+{
+    private static final StudiesManager _instance = new StudiesManager();
+
+    private StudiesManager()
+    {
+        // prevent external construction with a private default constructor
+    }
+
+    public static StudiesManager get()
+    {
+        return _instance;
+    }
+}

Studies/src/org/labkey/studies/StudiesModule.java

@@ -0,0 +1,68 @@
+package org.labkey.studies;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.labkey.api.data.Container;
+import org.labkey.api.module.DefaultModule;
+import org.labkey.api.module.ModuleContext;
+import org.labkey.api.view.WebPartFactory;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+
+public class StudiesModule extends DefaultModule
+{
+    public static final String NAME = "Studies";
+
+    @Override
+    public String getName()
+    {
+        return NAME;
+    }
+
+    @Override
+    public @Nullable Double getSchemaVersion()
+    {
+        return 23.000;
+    }
+
+    @Override
+    public boolean hasScripts()
+    {
+        return true;
+    }
+
+    @Override
+    @NotNull
+    protected Collection<WebPartFactory> createWebPartFactories()
+    {
+        return Collections.emptyList();
+    }
+
+    @Override
+    protected void init()
+    {
+        addController(StudiesController.NAME, StudiesController.class);
+    }
+
+    @Override
+    public void doStartup(ModuleContext moduleContext)
+    {
+
+    }
+
+    @Override
+    @NotNull
+    public Collection<String> getSummary(Container c)
+    {
+        return Collections.emptyList();
+    }
+
+    @Override
+    @NotNull
+    public Set<String> getSchemaNames()
+    {
+        return Collections.singleton(StudiesSchema.NAME);
+    }
+}

Studies/src/org/labkey/studies/StudiesSchema.java

@@ -0,0 +1,31 @@
+package org.labkey.studies;
+
+import org.labkey.api.data.DbSchema;
+import org.labkey.api.data.DbSchemaType;
+import org.labkey.api.data.dialect.SqlDialect;
+
+public class StudiesSchema
+{
+    private static final StudiesSchema _instance = new StudiesSchema();
+    public static final String NAME = "studies";
+
+    public static StudiesSchema getInstance()
+    {
+        return _instance;
+    }
+
+    private StudiesSchema()
+    {
+
+    }
+
+    public DbSchema getSchema()
+    {
+        return DbSchema.get(NAME, DbSchemaType.Module);
+    }
+
+    public SqlDialect getSqlDialect()
+    {
+        return getSchema().getSqlDialect();
+    }
+}

Studies/test/src/org/labkey/test/tests/studies/StudiesTest.java

@@ -0,0 +1,66 @@
+package org.labkey.test.tests.studies;
+
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.labkey.test.BaseWebDriverTest;
+import org.labkey.test.TestTimeoutException;
+import org.labkey.test.categories.InDevelopment;
+
+import java.util.Collections;
+import java.util.List;
+
+@Category({InDevelopment.class})
+public class StudiesTest extends BaseWebDriverTest
+{
+    @Override
+    protected void doCleanup(boolean afterTest) throws TestTimeoutException
+    {
+        _containerHelper.deleteProject(getProjectName(), afterTest);
+    }
+
+    @BeforeClass
+    public static void setupProject()
+    {
+        StudiesTest init = (StudiesTest)getCurrentTest();
+
+        init.doSetup();
+    }
+
+    private void doSetup()
+    {
+        _containerHelper.createProject(getProjectName(), null);
+    }
+
+    @Before
+    public void preTest()
+    {
+        goToProjectHome();
+    }
+
+    @Test
+    public void testStudiesModule()
+    {
+        _containerHelper.enableModule("Studies");
+
+    }
+
+    @Override
+    protected BrowserType bestBrowser()
+    {
+        return BrowserType.CHROME;
+    }
+
+    @Override
+    protected String getProjectName()
+    {
+        return "StudiesTest Project";
+    }
+
+    @Override
+    public List<String> getAssociatedModules()
+    {
+        return Collections.singletonList("Studies");
+    }
+}