Merge pull request #101 from fkrafi/feature/support_list_workspace

Added support for getting list of workspaces

Author: kirankotari

python_terraform/terraform.py

@@ -456,6 +456,25 @@ def show_workspace(self, **kwargs) -> CommandOutput:
         """
         return self.cmd("workspace", "show", **kwargs)
 
+    def list_workspace(self) -> List[str]:
+        """List of workspaces
+        
+        :return: workspaces
+        :example:
+            >>> tf = Terraform()
+            >>> tf.list_workspace()
+            ['default', 'test']
+        """
+        return list(
+            filter(
+                lambda workspace: len(workspace) > 0,
+                map(
+                    lambda workspace: workspace.strip('*').strip(),
+                    (self.cmd("workspace", "list")[1] or '').split()
+                )
+            )
+        )
+
     def __exit__(self, exc_type, exc_value, traceback) -> None:
         self.temp_var_files.clean_up()
 

test/test_terraform.py

@@ -447,3 +447,9 @@ def test_delete_workspace_with_args(self, workspace_setup_teardown, caplog):
             f"Command: terraform workspace delete -force test {current_path}"
             in caplog.messages
         )
+
+    def test_list_workspace(self):
+        tf = Terraform(working_dir=current_path)
+        workspaces = tf.list_workspace()
+        assert len(workspaces) > 0
+        assert 'default' in workspaces