Allow using readonly/partitioned clients (#185)

Author: ca-johnson

README.md

@@ -91,6 +91,20 @@ steps:
           stream_switching: true
 ```
 
+### Use readonly/partitioned clients
+
+Readonly and partitioned client workspaces can be used to reduce impact of automated build systems on Perforce server performance.
+See related article [Readonly and Partitioned Client Workspaces](https://community.perforce.com/s/article/15372).
+
+Note that existing client workspaces must be deleted and re-created to change type.
+
+```yaml
+steps:
+    plugins:
+      - improbable-eng/perforce:
+          client_type: partitioned
+```
+
 ## Triggering Builds
 
 There are a few options for triggering builds that use this plugin, in this order from least valuable but most convenient to most valuable but least convenient.

plugin.yml

@@ -21,5 +21,7 @@ configuration:
       type: string
     client_options:
       type: string
+    client_type:
+      type: string
     backup_changelists:
       type: bool

python/buildkite.py

@@ -51,6 +51,7 @@ def get_config():
     conf['sync'] = list_from_env_array('BUILDKITE_PLUGIN_PERFORCE_SYNC')
     conf['parallel'] = os.environ.get('BUILDKITE_PLUGIN_PERFORCE_PARALLEL') or 0
     conf['client_options'] = os.environ.get('BUILDKITE_PLUGIN_PERFORCE_CLIENT_OPTIONS')
+    conf['client_type'] = os.environ.get('BUILDKITE_PLUGIN_PERFORCE_CLIENT_TYPE')
 
     if 'BUILDKITE_PLUGIN_PERFORCE_ROOT' in os.environ and not __LOCAL_RUN__:
         raise Exception("Custom P4 root is for use in unit tests only")

python/fixture/server.zip

@@ -15,14 +15,15 @@
 
 class P4Repo:
     """A class for manipulating perforce workspaces"""
-    def __init__(self, root=None, view=None, stream=None,
-                 sync=None, client_options=None, parallel=0):
+    def __init__(self, root=None, view=None, stream=None, sync=None,
+                 client_options=None, client_type=None, parallel=0):
         """
         root: Directory in which to create the client workspace
         view: Client workspace mapping
         stream: Client workspace stream. Overrides view parameter.
         sync: List of paths to sync. Defaults to entire view.
         client_options: Additional options to add to client. (e.g. allwrite)
+        client_type: Type of client (writeable, readonly, partitioned)
         parallel: How many threads to use for parallel sync.
         """
         self.root = os.path.abspath(root or '')
@@ -31,6 +32,7 @@ def __init__(self, root=None, view=None, stream=None,
         self.sync_paths = sync or ['//...']
         assert isinstance(self.sync_paths, list)
         self.client_options = client_options or ''
+        self.client_type = client_type or 'writeable'
         self.parallel = parallel
 
         self.created_client = False
@@ -90,6 +92,7 @@ def _setup_client(self):
             client._stream = self.stream
         if self.view:
             client._view = self.view
+        client._type = self.client_type
 
         # unless overidden, overwrite writeable-but-unopened files
         # (e.g. interrupted syncs, artefacts that have been checked-in)

python/perforce.py

@@ -256,6 +256,27 @@ def test_checkout_label(server, tmpdir):
     with open(os.path.join(tmpdir, "file.txt")) as content:
         assert content.read() == "Hello World\n", "Unexpected content in workspace file"     
 
+def test_readonly_client(server, tmpdir):
+    """Test creation of a readonly client"""
+    repo = P4Repo(root=tmpdir, client_type='readonly')
+    repo.sync()
+    assert "file.txt" in os.listdir(tmpdir), "Workspace file was not synced"
+
+def test_partitioned_client(server, tmpdir):
+    """Test creation of a partitioned client"""
+    repo = P4Repo(root=tmpdir, client_type='partitioned')
+    repo.sync()
+    assert "file.txt" in os.listdir(tmpdir), "Workspace file was not synced"
+
+def test_modify_client_type(server, tmpdir):
+    """Test modifying a clients type"""
+    repo = P4Repo(root=tmpdir, client_type='writeable')
+    repo.sync()
+
+    with pytest.raises(Exception, match=r'Client storage type cannot be changed after client is created'):
+        repo = P4Repo(root=tmpdir, client_type='readonly')
+        repo.sync()
+
 def test_workspace_recovery(server, tmpdir):
     """Test that we can detect and recover from various workspace snafus"""
     repo = P4Repo(root=tmpdir)