Merge pull request #36 from dodecatheon/configurable-workspace-dir

douglasjacobsen · web-flow · commit e1f86c8e0b7f · 2023-02-15T16:29:10.000-07:00
Allow workspace_path to be set via config:user:workspace_dir
diff --git a/etc/ramble/defaults/config.yaml b/etc/ramble/defaults/config.yaml
@@ -24,3 +24,4 @@ config:
       install: '--reuse'
       concretize: '--reuse'
     input_cache: $ramble/var/ramble/cache
+    workspace_dirs: $ramble/var/ramble/workspaces
diff --git a/lib/ramble/ramble/cmd/workspace.py b/lib/ramble/ramble/cmd/workspace.py
@@ -106,19 +106,22 @@ def workspace_activate(args):
     # Temporary workspace
     if args.temp:
         workspace = create_temp_workspace_directory()
-        workspace_path = os.path.abspath(workspace)
-        short_name = os.path.basename(workspace_path)
+        wspath_dir = os.path.abspath(workspace)
+        ramble.workspace.set_workspace_path(wspath_dir)
+        short_name = os.path.basename(wspath_dir)
         ramble.workspace.Workspace(workspace).write()
 
     # Named workspace
     elif ramble.workspace.exists(workspace_name_or_dir) and not args.dir:
-        workspace_path = ramble.workspace.root(workspace_name_or_dir)
+        wspath_dir = ramble.workspace.root(workspace_name_or_dir)
+        ramble.workspace.set_workspace_path(wspath_dir)
         short_name = workspace_name_or_dir
 
     # Workspace directory
     elif ramble.workspace.is_workspace_dir(workspace_name_or_dir):
-        workspace_path = os.path.abspath(workspace_name_or_dir)
-        short_name = os.path.basename(workspace_path)
+        workspace_path_dir = os.path.abspath(workspace_name_or_dir)
+        ramble.workspace.set_workspace_path(workspace_path_dir)
+        short_name = os.path.basename(workspace_path_dir)
 
     else:
         tty.die("No such workspace: '%s'" % workspace_name_or_dir)
@@ -134,7 +137,8 @@ def workspace_activate(args):
         env_mods = ramble.workspace.shell.deactivate()
 
     # Activate new workspace
-    active_workspace = ramble.workspace.Workspace(workspace_path)
+    workspace_path_dir = ramble.workspace.get_workspace_path()
+    active_workspace = ramble.workspace.Workspace(workspace_path_dir)
     cmds += ramble.workspace.shell.activate_header(
         ws=active_workspace,
         shell=args.shell,
diff --git a/lib/ramble/ramble/config.py b/lib/ramble/ramble/config.py
@@ -118,7 +118,8 @@
             'install': '--reuse',
             'concretize': '--reuse'
         },
-        'input_cache': '$ramble/var/ramble/cache'
+        'input_cache': '$ramble/var/ramble/cache',
+        'workspace_dirs': '$ramble/var/ramble/workspaces'
     }
 }
 
diff --git a/lib/ramble/ramble/schema/config.py b/lib/ramble/ramble/schema/config.py
@@ -50,6 +50,11 @@
     'default': '$ramble/var/ramble/cache'
 }
 
+properties['config']['workspace_dirs'] = {
+    'type': 'string',
+    'default': '$ramble/var/ramble/workspaces'
+}
+
 #: Full schema with metadata
 schema = {
     '$schema': 'http://json-schema.org/schema#',
diff --git a/lib/ramble/ramble/test/cmd/on.py b/lib/ramble/ramble/test/cmd/on.py
@@ -15,16 +15,17 @@
 from ramble.main import RambleCommand
 
 # everything here uses the mock_workspace_path
-pytestmark = pytest.mark.usefixtures(
-    'mutable_mock_workspace_path', 'config', 'mutable_mock_repo')
+pytestmark = pytest.mark.usefixtures('mutable_config',
+                                     'mutable_mock_workspace_path',
+                                     'mutable_mock_repo')
 
 workspace = RambleCommand('workspace')
 add = RambleCommand('add')
 remove = RambleCommand('remove')
 on = RambleCommand('on')
 
 
-def test_on_command():
+def test_on_command(mutable_mock_workspace_path):
     ws_name = 'test'
     workspace('create', ws_name)
 
@@ -41,7 +42,7 @@ def test_on_command():
         on()
 
 
-def test_execute_nothing():
+def test_execute_nothing(mutable_mock_workspace_path):
     ws_name = 'test'
     workspace('create', ws_name)
     assert ws_name in workspace('list')
diff --git a/lib/ramble/ramble/test/cmd/workspace.py b/lib/ramble/ramble/test/cmd/workspace.py
@@ -16,8 +16,9 @@
 from ramble.main import RambleCommand, RambleCommandError
 
 # everything here uses the mock_workspace_path
-pytestmark = pytest.mark.usefixtures(
-    'mutable_mock_workspace_path', 'config', 'mutable_mock_repo')
+pytestmark = pytest.mark.usefixtures('mutable_config',
+                                     'mutable_mock_workspace_path',
+                                     'mutable_mock_repo')
 
 config = RambleCommand('config')
 workspace = RambleCommand('workspace')
@@ -210,6 +211,39 @@ def test_workspace_from_template(tmpdir):
         assert num_templates > 0
 
 
+def test_workspace_dirs(tmpdir, mutable_mock_workspace_path):
+    with tmpdir.as_cwd():
+        # Make a temp directory,
+        # Set it up as the workspace_dirs path,
+        # make a test workspace there, and
+        # verify the workspace was created where
+        # it would be expected
+        wsdir1 = os.path.join(os.getcwd(), 'ws1')
+        os.makedirs(wsdir1)
+        ramble.workspace.set_workspace_path(wsdir1)
+        workspace('create', 'test1')
+        out = workspace('list')
+        assert 'test1' in out
+
+        # Now make a second temp directory,
+        # follow same process to make another test
+        # workspace, and verify that the first
+        # test workspace is not found while the
+        # second is
+        wsdir2 = os.path.join(os.getcwd(), 'ws2')
+        os.makedirs(wsdir2)
+        ramble.workspace.set_workspace_path(wsdir2)
+        workspace('create', 'test2')
+        out = workspace('list')
+        assert 'test2' in out
+        assert 'test1' not in out
+
+        # Cleanup after test
+        workspace('remove', '-y', 'test2')
+        ramble.workspace.set_workspace_path(wsdir1)
+        workspace('remove', '-y', 'test1')
+
+
 def test_remove_workspace(capfd):
     workspace('create', 'foo')
     workspace('create', 'bar')
diff --git a/lib/ramble/ramble/test/conftest.py b/lib/ramble/ramble/test/conftest.py
@@ -62,7 +62,7 @@ def pytest_collection_modifyitems(config, items):
 #
 @pytest.fixture(scope='function', autouse=True)
 def no_chdir():
-    """Ensure that no test changes Ramble's working dirctory.
+    """Ensure that no test changes Ramble's working directory.
 
     This prevents Ramble tests (and therefore Ramble commands) from
     changing the working directory and causing other tests to fail
@@ -231,8 +231,11 @@ def mutable_config(tmpdir_factory, configuration_dir):
     mutable_dir = tmpdir_factory.mktemp('mutable_config').join('tmp')
     configuration_dir.copy(mutable_dir)
 
-    scopes = [ramble.config.ConfigScope(name, str(mutable_dir.join(name)))
-              for name in ['site', 'system', 'user']]
+    defaults = ramble.config.InternalConfigScope('_builtin',
+                                                 ramble.config.config_defaults)
+    scopes  = [defaults]
+    scopes += [ramble.config.ConfigScope(name, str(mutable_dir.join(name)))
+               for name in ['site', 'system', 'user']]
 
     with ramble.config.use_configuration(*scopes) as cfg:
         yield cfg
@@ -381,14 +384,14 @@ def _factory(name, output, subdir=('bin',)):
     return _factory
 
 
-@pytest.fixture()
-def mutable_mock_workspace_path(tmpdir_factory):
+@pytest.fixture(scope='function')
+def mutable_mock_workspace_path(tmpdir_factory, mutable_config):
     """Fixture for mocking the internal ramble workspaces directory."""
-    saved_path = ramble.workspace.workspace_path
+    saved_path = ramble.workspace.get_workspace_path()
     mock_path = tmpdir_factory.mktemp('mock-workspace-path')
-    ramble.workspace.workspace.workspace_path = str(mock_path)
+    ramble.workspace.set_workspace_path(str(mock_path))
     yield mock_path
-    ramble.workspace.workspace.workspace_path = saved_path
+    ramble.workspace.set_workspace_path(saved_path)
 
 
 @pytest.fixture
diff --git a/lib/ramble/ramble/test/end_to_end.py b/lib/ramble/ramble/test/end_to_end.py
@@ -15,13 +15,13 @@
 from ramble.main import RambleCommand
 
 # everything here uses the mock_workspace_path
-pytestmark = pytest.mark.usefixtures(
-    'mutable_mock_workspace_path', 'config')
+pytestmark = pytest.mark.usefixtures('mutable_config',
+                                     'mutable_mock_workspace_path')
 
 workspace = RambleCommand('workspace')
 
 
-def test_wrfv4_dry_run():
+def test_wrfv4_dry_run(mutable_config, mutable_mock_workspace_path):
     test_config = """
 ramble:
   mpi:
diff --git a/lib/ramble/ramble/test/expander.py b/lib/ramble/ramble/test/expander.py
@@ -12,8 +12,10 @@
 import ramble.expander
 from ramble.main import RambleCommand
 
-pytestmark = pytest.mark.usefixtures(
-    'mutable_mock_workspace_path', 'config', 'mutable_mock_repo')
+pytestmark = pytest.mark.usefixtures('mutable_config',
+                                     'mutable_mock_workspace_path',
+                                     'mutable_mock_repo',
+                                     )
 
 workspace  = RambleCommand('workspace')
 add  = RambleCommand('add')
diff --git a/lib/ramble/ramble/test/mirror_tests.py b/lib/ramble/ramble/test/mirror_tests.py
@@ -23,7 +23,11 @@
 
 pytestmark = [pytest.mark.skipif(sys.platform == "win32",
                                  reason="does not run on windows"),
-              pytest.mark.usefixtures('mutable_config', 'mutable_mock_repo')]
+              pytest.mark.usefixtures('tmpdir',
+                                      'tmpdir_factory',
+                                      'mutable_config',
+                                      'mutable_mock_workspace_path',
+                                      'mutable_mock_repo')]
 
 
 class MockFetcher(object):
@@ -86,7 +90,7 @@ def check_mirror(mirror_path, app_name, app_class):
 ])
 def test_mirror_create(tmpdir, mutable_mock_repo,
                        mutable_mock_workspace_path,
-                       config, app_name, tmpdir_factory):
+                       app_name, tmpdir_factory):
 
     test_config = f"""
 ramble:
diff --git a/lib/ramble/ramble/workspace/__init__.py b/lib/ramble/ramble/workspace/__init__.py
@@ -28,7 +28,8 @@
     default_config_yaml,
     exists,
     is_workspace_dir,
-    workspace_path,
+    get_workspace_path,
+    set_workspace_path,
     config_file,
     config_file_name,
     workspace_software_path,
@@ -59,7 +60,8 @@
     'default_config_yaml',
     'exists',
     'is_workspace_dir',
-    'workspace_path',
+    'get_workspace_path',
+    'set_workspace_path',
     'config_file',
     'config_file_name',
     'workspace_software_path',
diff --git a/lib/ramble/ramble/workspace/workspace.py b/lib/ramble/ramble/workspace/workspace.py
@@ -61,9 +61,6 @@
 #: Currently activated workspace
 _active_workspace = None
 
-#: Path where workspaces are stored
-workspace_path = os.path.join(ramble.paths.var_path, 'workspaces')
-
 #: Subdirectory where workspace configs are stored
 workspace_config_path = 'configs'
 
@@ -253,10 +250,11 @@ def all_workspace_names():
     """List the names of workspaces that currently exist."""
     # just return empty if the workspace path does not exist.  A read-only
     # operation like list should not try to create a directory.
-    if not os.path.exists(workspace_path):
+    wspath = get_workspace_path()
+    if not os.path.exists(wspath):
         return []
 
-    candidates = sorted(os.listdir(workspace_path))
+    candidates = sorted(os.listdir(wspath))
     names = []
     for candidate in candidates:
         configured = True
@@ -281,9 +279,25 @@ def active_workspace():
     return _active_workspace
 
 
+def get_workspace_path():
+    """Returns current directory of ramble-managed workspaces"""
+    path_in_config = ramble.config.get('config:workspace_dirs')
+    if not path_in_config:
+        path_in_config = '$ramble/var/ramble/GET_WORKSPACE_ERROR/'
+
+    wspath = ramble.util.path.canonicalize_path(path_in_config)
+    return wspath
+
+
+def set_workspace_path(dirname):
+    """Sets the parent directory of ramble-managed workspaces"""
+    ramble.config.set('config:workspace_dirs:', dirname)
+
+
 def _root(name):
     """Non-validating version of root(), to be used internally."""
-    return os.path.join(workspace_path, name)
+    wspath = get_workspace_path()
+    return os.path.join(wspath, name)
 
 
 def root(name):
@@ -1384,7 +1398,8 @@ def batch_submit(self):
     @property
     def internal(self):
         """Whether this workspace is managed by Ramble."""
-        return self.path.startswith(workspace_path)
+        wspath = get_workspace_path()
+        return self.path.startswith(wspath)
 
     @property
     def name(self):

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,8 @@`
`118`	`118`	`'install': '--reuse',`
`119`	`119`	`'concretize': '--reuse'`
`120`	`120`	`},`
`121`		`- 'input_cache': '$ramble/var/ramble/cache'`
	`121`	`+ 'input_cache': '$ramble/var/ramble/cache',`
	`122`	`+ 'workspace_dirs': '$ramble/var/ramble/workspaces'`
`122`	`123`	`}`
`123`	`124`	`}`
`124`	`125`