[SHOT-3592] Introduce Review with VRED into basic config (#98)

* Added tk-shotgun-launchvredreview.yml, version.yml, and version specific handling in pick_environment.py.
* Replicate project environment in the Version environment to avoid losing any functionality, and add any engine specific Version handling. Move shotgun.version settings to its own version.yml file.

Author: rob-aitchison

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ exclude: "ui\/.*py$"
 # List of super useful formatters.
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.2.3
+    rev: v3.2.0
     hooks:
     # Ensures the code is syntaxically correct
     - id: check-ast
@@ -35,7 +35,7 @@ repos:
     - id: trailing-whitespace
   # Leave black at the bottom so all touchups are done before it is run.
   - repo: https://github.com/ambv/black
-    rev: stable
+    rev: 20.8b1
     hooks:
     - id: black
       language_version: python3

core/hooks/pick_environment.py

@@ -21,8 +21,11 @@ class PickEnvironment(Hook):
 
     def execute(self, context, **kwargs):
 
-        if context.source_entity and context.source_entity["type"] == "PublishedFile":
-            return "publishedfile"
+        if context.source_entity:
+            if context.source_entity["type"] == "Version":
+                return "version"
+            elif context.source_entity["type"] == "PublishedFile":
+                return "publishedfile"
 
         if context.entity and context.step is None:
             # We have an entity but no step.

env/includes/common/apps.yml

@@ -77,6 +77,11 @@ common.apps.tk-shotgun-launchfolder.location:
   name: tk-shotgun-launchfolder
   version: v0.2.1
 
+common.apps.tk-shotgun-launchvredreview.location:
+  type: app_store
+  name: tk-shotgun-launchvredreview
+  version: v1.0.0
+
 # help urls
 
 common.apps.tk-multi-publish2.help_url: https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-User-Guide#The%20Publisher

env/includes/shotgun/version.yml

@@ -0,0 +1,43 @@
+# Copyright (c) 2016 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+#
+
+# this configuration defines the behavior of the Shotgun Desktop when it
+# is running in its project level configuration
+
+includes:
+- ../common/engines.yml
+- ../common/apps.yml
+- ../common/settings/tk-multi-publish2.yml
+
+shotgun.version:
+  apps:
+
+    tk-multi-publish2:
+      collector: "{self}/collector.py"
+      publish_plugins:
+        - '@common.settings.tk-multi-publish2.publish_file'
+        - '@common.settings.tk-multi-publish2.upload_version'
+      location: "@common.apps.tk-multi-publish2.location"
+
+    tk-multi-launchapp:
+      scan_all_projects: true
+      use_software_entity: true
+      hook_before_register_command: "{config}/tk-multi-launchapp/before_register_command.py"
+      location: "@common.apps.tk-multi-launchapp.location"
+
+    settings.tk-shotgun-launchvredreview:
+      deny_platforms: [ Mac, Linux ]
+      viewer_extensions: [ vpb ]
+      hook_verify_install: "{self}/verify_install.py"
+      hook_launch_publish: "{self}/shotgun_launch_vred.py"
+      location: "@common.apps.tk-shotgun-launchvredreview.location"
+
+  location: "@common.engines.tk-shotgun.location"

env/version.yml

@@ -0,0 +1,49 @@
+# Copyright (c) 2020 Autodesk, Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Autodesk, Inc.
+#
+
+# The Version environment was created to allow for Version specific actions.
+# To maintain functionality before this Version environment was introduced,
+# the Project environment has been replicated here, since that is the environment
+# that Versions used to have.
+description: Toolkit configuration to be loaded whenever an association with a
+             Version has been established.
+
+includes:
+- includes/houdini/project.yml
+- includes/maya/project.yml
+- includes/nuke/project.yml
+- includes/flame/project.yml
+- includes/desktop/project.yml
+- includes/desktop2/all.yml
+- includes/shell/project.yml
+- includes/photoshopcc/project.yml
+- includes/aftereffects/project.yml
+- includes/3dsmax/project.yml
+- includes/alias/project.yml
+- includes/shotgun/version.yml
+- includes/vred/project.yml
+
+engines:
+  tk-3dsmax: '@3dsmax.project'
+  tk-3dsmaxplus: '@3dsmaxplus.project'
+  tk-aftereffects: '@aftereffects.project'
+  tk-alias: '@alias.project'
+  tk-desktop: '@desktop.project'
+  tk-desktop2: '@desktop2.all'
+  tk-flame: '@flame.project'
+  tk-houdini: '@houdini.project'
+  tk-maya: '@maya.project'
+  tk-nuke: '@nuke.project'
+  tk-nukestudio: '@nukestudio.project'
+  tk-photoshopcc: '@photoshopcc.project'
+  tk-shell: '@shell.project'
+  tk-shotgun: '@shotgun.version'
+  tk-vred: '@vred.project'