Add test harness

.gitignore

@@ -1,2 +1,4 @@
+cover
+.coverage
 examples/maya/private**
 examples/maya/public**

.noserc

@@ -0,0 +1,9 @@
+[nosetests]
+verbosity=2
+with-doctest=1
+with-coverage=1
+exclude=vendor
+cover-html=1
+cover-erase=1
+cover-tests=1
+cover-package=pyblish_starter

README.md

@@ -43,11 +43,11 @@ $ pip install pyblish-starter
 
 ### Usage
 
-Starter is initialised by calling `setup()`.
+Starter is initialised by calling `install()`.
 
 ```python
 >>> import pyblish_starter
->>> pyblish_starter.setup()
+>>> pyblish_starter.install()
 ```
 
 From here, you model, rig and animate as per the contract below.

pyblish_starter/__init__.py

@@ -1,13 +1,20 @@
 from .pipeline import (
     ls,
-    setup,
+    install,
+    register_root,
+    register_loader,
+    register_creator,
     register_plugins,
     format_private_dir,
 )
 
 
 __all__ = [
     "ls",
-    "setup",
+    "install",
     "register_plugins",
+    "register_root",
+    "register_loader",
+    "register_creator",
+    "format_private_dir",
 ]

pyblish_starter/maya/pythonpath/userSetup.py

@@ -1,2 +1,2 @@
 import pyblish_starter
-pyblish_starter.setup()
+pyblish_starter.install()

pyblish_starter/pipeline.py

@@ -17,8 +17,8 @@
 self._log = logging.getLogger()
 
 
-def setup(root, loader, creator):
-    """Setup the running Python session.
+def install(root, loader, creator):
+    """install the running Python session.
 
     Arguments:
         root (str): Absolute path to assets
@@ -55,9 +55,9 @@ def setup(root, loader, creator):
     )
 
 
-def ls(root):
+def ls():
     """List available assets"""
-    dirname = os.path.join(root, "public")
+    dirname = os.path.join(self.registered_root(), "public")
     self._log.debug("Listing %s" % dirname)
     return os.listdir(dirname)
 

pyblish_starter/plugins/collect_instances.py

@@ -45,11 +45,11 @@ def process(self, context):
 
         try:
             import pyblish_maya
-            assert pyblish_maya.is_setup()
+            assert pyblish_maya.is_install()
 
         except (ImportError, AssertionError):
             raise RuntimeError("pyblish-starter requires pyblish-maya "
-                               "to have been setup.")
+                               "to have been install.")
 
         for objset in cmds.ls("*.id",
                               long=True,            # Produce full names

pyblish_starter/tests/test_pipeline.py

@@ -0,0 +1,33 @@
+import os
+import sys
+import shutil
+import tempfile
+
+import pyblish_starter
+
+self = sys.modules[__name__]
+
+
+def setup():
+    self.tempdir = tempfile.mkdtemp()
+    sys.stdout.write("Created temporary directory \"%s\"" % self.tempdir)
+
+
+def teardown():
+    shutil.rmtree(self.tempdir)
+    sys.stdout.write("Removed temporary directory \"%s\"" % self.tempdir)
+
+
+def test_ls():
+    """ls() returns available assets from current root directory"""
+    root = os.path.join(
+        self.tempdir,
+        "public"
+    )
+
+    for asset in ("Asset1", "Asset2"):
+        os.makedirs(os.path.join(root, asset))
+
+    pyblish_starter.register_root(self.tempdir)
+
+    assert pyblish_starter.ls() == ["Asset1", "Asset2"]

pyblish_starter/tools/instance_creator/app.py

@@ -190,7 +190,7 @@ def show(creator=None, debug=False):
     if creator is None:
         raise ValueError("No creator registered.\n"
                          "A creator must be either registered in "
-                         "pyblish_starter.setup(creator=) or "
+                         "pyblish_starter.install(creator=) or "
                          "passed to show(creator=).")
 
     if debug:

run_tests.py

@@ -0,0 +1,18 @@
+import sys
+import time
+import types
+
+maya = types.ModuleType("maya")
+maya.mel = types.ModuleType("mel")
+maya.cmds = types.ModuleType("cmds")
+
+maya.cmds.ls = lambda *args, **kwargs: ["pCube1"]
+maya.mel.eval = lambda string: None
+
+sys.modules["maya"] = maya
+
+if __name__ == '__main__':
+    import nose
+    argv = sys.argv[:]
+    argv.extend(['-c', '.noserc'])
+    nose.main(argv=argv)