def process(self, session, **kwargs): """Implement the behavior for when the action is triggered Args: session (dict): environment dictionary Returns: Popen instance of newly spawned process """ with pype.modified_environ(**session): # Get executable by name app = lib.get_application(self.name) executable = lib.which(app["executable"]) # Run as server arguments = [] tools_env = acre.get_tools([self.name]) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(os.environ)) if not env.get('AVALON_WORKDIR', None): pype.load_data_from_templates() os.environ["AVALON_WORKDIR"] = pype.get_workdir_template( pype.Anatomy) pype.reset_data_from_templates() env.update(dict(os.environ)) lib.launch(executable=executable, args=arguments, environment=env) return
def test_get_tools(self): """Get tools works""" self.setup_sample("sample1") env = acre.get_tools(["global"]) self.assertEqual(env, {"PIPELINE": "P:/pipeline/dev2_1"})
def test_compute_tools(self): self.setup_sample("sample1") env = acre.get_tools(["maya_2018"], platform_name="windows") env = acre.compute(env) self.assertEqual(env["MAYA_LOCATION"], "C:/Program Files/Autodesk/Maya2018")
def process(self, session, **kwargs): """Implement the behavior for when the action is triggered Args: session (dict): environment dictionary Returns: Popen instance of newly spawned process """ with pype.modified_environ(**session): # Get executable by name app = lib.get_application(self.name) executable = lib.which(app["executable"]) # Run as server arguments = [] tools_env = acre.get_tools([self.name]) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(os.environ)) if not env.get('AVALON_WORKDIR', None): project_name = env.get("AVALON_PROJECT") anatomy = Anatomy(project_name) os.environ['AVALON_PROJECT'] = project_name io.Session['AVALON_PROJECT'] = project_name task_name = os.environ.get("AVALON_TASK", io.Session["AVALON_TASK"]) asset_name = os.environ.get("AVALON_ASSET", io.Session["AVALON_ASSET"]) application = lib.get_application( os.environ["AVALON_APP_NAME"]) project_doc = io.find_one({"type": "project"}) data = { "task": task_name, "asset": asset_name, "project": { "name": project_doc["name"], "code": project_doc["data"].get("code", '') }, "hierarchy": pype.get_hierarchy(), "app": application["application_dir"] } anatomy_filled = anatomy.format(data) workdir = anatomy_filled["work"]["folder"] os.environ["AVALON_WORKDIR"] = workdir env.update(dict(os.environ)) lib.launch(executable=executable, args=arguments, environment=env) return
def test_get_with_platform(self): """Get tools works""" self.setup_sample("sample1") env = acre.get_tools(["maya_2018"], platform_name="darwin") self.assertEqual(env["PATH"], "{MAYA_LOCATION}/bin") # Test Mac only path self.assertTrue("DYLD_LIBRARY_PATH" in env) self.assertEqual(env["DYLD_LIBRARY_PATH"], "{MAYA_LOCATION}/MacOS") env = acre.get_tools(["maya_2018"], platform_name="windows") self.assertEqual( env["PATH"], ";".join([ "{MAYA_LOCATION}/bin", "C:/Program Files/Common Files/Autodesk Shared/", "C:/Program Files (x86)/Autodesk/Backburner/" ])) # Test Mac only path not present in windows self.assertTrue("DYLD_LIBRARY_PATH" not in env)
def _load_default_environments(self, tools): """Load and apply default environment files.""" import acre os.environ['PLATFORM'] = platform.system().lower() tools_env = acre.get_tools(tools) pype_paths_env = dict() for key, value in dict(os.environ).items(): if key.startswith('PYPE_'): pype_paths_env[key] = value env = acre.append(tools_env, pype_paths_env) env = acre.compute(env, cleanup=True) os.environ = acre.append(dict(os.environ), env) os.environ = acre.compute(os.environ, cleanup=False)
def add_tool_to_environment(tools): """ It is adding dynamic environment to os environment. Args: tool (list, tuple): list of tools, name should corespond to json/toml Returns: os.environ[KEY]: adding to os.environ """ import acre tools_env = acre.get_tools(tools) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(os.environ)) os.environ.update(env)
def run_application(self, app, project, asset, task, tools, arguments): """Run application in project/asset/task context. With default or specified tools enviornment. This uses pre-defined launcher in `pype-config/launchers` where there must be *toml* file with definition and in platform directory its launcher shell script or binary executables. Arguments will be passed to this script or executable. :param app: Full application name (`maya_2018`) :type app: Str :param project: Project name :type project: Str :param asset: Asset name :type asset: Str :param task: Task name :type task: Str :param tools: Comma separated list of tools (`"mtoa_2.1.0,yeti_4"`) :type tools: Str :param arguments: List of other arguments passed to app :type: List :rtype: None """ import toml import subprocess from pypeapp.lib.Terminal import Terminal from pypeapp import Anatomy t = Terminal() self._initialize() self._update_python_path() import acre from avalon import lib from pype import lib as pypelib abspath = lib.which_app(app) if abspath is None: t.echo("!!! Application [ {} ] is not registered.".format(app)) t.echo("*** Please define its toml file.") return app_toml = toml.load(abspath) executable = app_toml['executable'] app_dir = app_toml['application_dir'] # description = app_toml.get('description', None) # preactions = app_toml.get('preactions', []) launchers_path = os.path.join(os.environ["PYPE_CONFIG"], "launchers") database = pypelib.get_avalon_database() avalon_project = database[project].find_one({"type": "project"}) if avalon_project is None: t.echo( "!!! Project [ {} ] doesn't exists in Avalon.".format(project)) return False # get asset from db avalon_asset = database[project].find_one({ "type": "asset", "name": asset }) avalon_tools = avalon_project["data"]["tools_env"] if tools: avalon_tools = tools.split(",") or [] hierarchy = "" parents = avalon_asset["data"]["parents"] or [] if parents: hierarchy = os.path.join(*parents) data = { "project": { "name": project, "code": avalon_project['data']['code'] }, "task": task, "asset": asset, "app": app_dir, "hierarchy": hierarchy, } anatomy = Anatomy(project) anatomy_filled = anatomy.format(data) workdir = os.path.normpath(anatomy_filled["work"]["folder"]) # set PYPE_ROOT_* environments anatomy.set_root_environments() # set environments for Avalon os.environ["AVALON_PROJECT"] = project os.environ["AVALON_SILO"] = None os.environ["AVALON_ASSET"] = asset os.environ["AVALON_TASK"] = task os.environ["AVALON_APP"] = app.split("_")[0] os.environ["AVALON_APP_NAME"] = app os.environ["AVALON_WORKDIR"] = workdir os.environ["AVALON_HIERARCHY"] = hierarchy try: os.makedirs(workdir) except FileExistsError: pass tools_attr = [os.environ["AVALON_APP"], os.environ["AVALON_APP_NAME"]] tools_attr += avalon_tools print("TOOLS: {}".format(tools_attr)) tools_env = acre.get_tools(tools_attr) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(os.environ)) env = {k: str(v) for k, v in env.items()} # sanitize slashes in path env["PYTHONPATH"] = env["PYTHONPATH"].replace("/", "\\") env["PYTHONPATH"] = env["PYTHONPATH"].replace("\\\\", "\\") launchers_path = os.path.join(launchers_path, platform.system().lower()) execfile = None if sys.platform == "win32": # test all avaliable executable format, find first and use it for ext in os.environ["PATHEXT"].split(os.pathsep): fpath = os.path.join(launchers_path.strip('"'), executable + ext) if os.path.isfile(fpath) and os.access(fpath, os.X_OK): execfile = fpath break # Run SW if was found executable if execfile is not None: try: t.echo(">>> Running [ {} {} ]".format( executable, " ".join(arguments))) args = [execfile] args.extend(arguments) subprocess.run(args, env=env) except ValueError as e: t.echo("!!! Error while launching application:") t.echo(e) return else: t.echo( "!!! cannot find application launcher [ {} ]".format(app)) return if sys.platform.startswith('linux'): execfile = os.path.join(launchers_path.strip('"'), executable) if os.path.isfile(execfile): try: fp = open(execfile) except PermissionError as p: t.echo("!!! Access denied on launcher [ {} ]".format(app)) t.echo(p) return fp.close() else: t.echo("!!! Launcher doesn\'t exist [ {} ]".format(execfile)) return # Run SW if was found executable if execfile is not None: args = ['/usr/bin/env', 'bash', execfile] args.extend(arguments) t.echo(">>> Running [ {} ]".format(" ".join(args))) try: subprocess.run(args, env=env) except ValueError as e: t.echo("!!! Error while launching application:") t.echo(e) return else: t.echo( "!!! cannot find application launcher [ {} ]".format(app)) return
def launch(self, session, entities, event): '''Callback method for the custom action. return either a bool ( True if successful or False if the action failed ) or a dictionary with they keys `message` and `success`, the message should be a string and will be displayed as feedback to the user, success should be a bool, True if successful or False if the action failed. *session* is a `ftrack_api.Session` instance *entities* is a list of tuples each containing the entity type and the entity id. If the entity is a hierarchical you will always get the entity type TypedContext, once retrieved through a get operation you will have the "real" entity type ie. example Shot, Sequence or Asset Build. *event* the unmodified original event ''' entity = entities[0] project_name = entity['project']['full_name'] database = pypelib.get_avalon_database() # Get current environments env_list = [ 'AVALON_PROJECT', 'AVALON_SILO', 'AVALON_ASSET', 'AVALON_TASK', 'AVALON_APP', 'AVALON_APP_NAME' ] env_origin = {} for env in env_list: env_origin[env] = os.environ.get(env, None) # set environments for Avalon os.environ["AVALON_PROJECT"] = project_name os.environ["AVALON_SILO"] = entity['ancestors'][0]['name'] os.environ["AVALON_ASSET"] = entity['parent']['name'] os.environ["AVALON_TASK"] = entity['name'] os.environ["AVALON_APP"] = self.identifier.split("_")[0] os.environ["AVALON_APP_NAME"] = self.identifier anatomy = Anatomy() hierarchy = "" parents = database[project_name].find_one({ "type": 'asset', "name": entity['parent']['name'] })['data']['parents'] if parents: hierarchy = os.path.join(*parents) application = avalonlib.get_application(os.environ["AVALON_APP_NAME"]) data = { "root": os.environ.get("PYPE_STUDIO_PROJECTS_MOUNT"), "project": { "name": entity['project']['full_name'], "code": entity['project']['name'] }, "task": entity['name'], "asset": entity['parent']['name'], "app": application["application_dir"], "hierarchy": hierarchy, } av_project = database[project_name].find_one({"type": 'project'}) templates = None if av_project: work_template = av_project.get('config', {}).get('template', {}).get('work', None) work_template = None try: work_template = work_template.format(**data) except Exception: try: anatomy = anatomy.format(data) work_template = anatomy["work"]["folder"] except Exception as exc: msg = "{} Error in anatomy.format: {}".format( __name__, str(exc)) self.log.error(msg, exc_info=True) return {'success': False, 'message': msg} workdir = os.path.normpath(work_template) os.environ["AVALON_WORKDIR"] = workdir try: os.makedirs(workdir) except FileExistsError: pass # collect all parents from the task parents = [] for item in entity['link']: parents.append(session.get(item['type'], item['id'])) # collect all the 'environment' attributes from parents tools_attr = [os.environ["AVALON_APP"], os.environ["AVALON_APP_NAME"]] for parent in reversed(parents): # check if the attribute is empty, if not use it if parent['custom_attributes']['tools_env']: tools_attr.extend(parent['custom_attributes']['tools_env']) break tools_env = acre.get_tools(tools_attr) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(os.environ)) env = acre.append(dict(os.environ), env) # # tools_env = acre.get_tools(tools) # env = acre.compute(dict(tools_env)) # env = acre.merge(env, dict(os.environ)) # os.environ = acre.append(dict(os.environ), env) # os.environ = acre.compute(os.environ) # Get path to execute st_temp_path = os.environ['PYPE_CONFIG'] os_plat = platform.system().lower() # Path to folder with launchers path = os.path.join(st_temp_path, 'launchers', os_plat) # Full path to executable launcher execfile = None if sys.platform == "win32": for ext in os.environ["PATHEXT"].split(os.pathsep): fpath = os.path.join(path.strip('"'), self.executable + ext) if os.path.isfile(fpath) and os.access(fpath, os.X_OK): execfile = fpath break pass # Run SW if was found executable if execfile is not None: avalonlib.launch(executable=execfile, args=[], environment=env) else: return { 'success': False, 'message': "We didn't found launcher for {0}".format(self.label) } pass if sys.platform.startswith('linux'): execfile = os.path.join(path.strip('"'), self.executable) if os.path.isfile(execfile): try: fp = open(execfile) except PermissionError as p: self.log.exception('Access denied on {0} - {1}'.format( execfile, p)) return { 'success': False, 'message': "Access denied on launcher - {}".format(execfile) } fp.close() # check executable permission if not os.access(execfile, os.X_OK): self.log.error( 'No executable permission on {}'.format(execfile)) return { 'success': False, 'message': "No executable permission - {}".format(execfile) } pass else: self.log.error('Launcher doesn\'t exist - {}'.format(execfile)) return { 'success': False, 'message': "Launcher doesn't exist - {}".format(execfile) } pass # Run SW if was found executable if execfile is not None: avalonlib.launch('/usr/bin/env', args=['bash', execfile], environment=env) else: return { 'success': False, 'message': "We didn't found launcher for {0}".format(self.label) } pass # Change status of task to In progress presets = config.get_presets()["ftrack"]["ftrack_config"] if 'status_update' in presets: statuses = presets['status_update'] actual_status = entity['status']['name'].lower() next_status_name = None for key, value in statuses.items(): if actual_status in value or '_any_' in value: if key != '_ignore_': next_status_name = key break if next_status_name is not None: try: query = 'Status where name is "{}"'.format( next_status_name) status = session.query(query).one() entity['status'] = status session.commit() except Exception: msg = ('Status "{}" in presets wasn\'t found on Ftrack' ).format(next_status_name) self.log.warning(msg) # Set origin avalon environments for key, value in env_origin.items(): if value == None: value = "" os.environ[key] = value return {'success': True, 'message': "Launching {0}".format(self.label)}
def launch(self, session, entities, event): """Callback method for the custom action. return either a bool (True if successful or False if the action failed) or a dictionary with they keys `message` and `success`, the message should be a string and will be displayed as feedback to the user, success should be a bool, True if successful or False if the action failed. *session* is a `ftrack_api.Session` instance *entities* is a list of tuples each containing the entity type and the entity id. If the entity is a hierarchical you will always get the entity type TypedContext, once retrieved through a get operation you will have the "real" entity type ie. example Shot, Sequence or Asset Build. *event* the unmodified original event """ entity = entities[0] project_name = entity["project"]["full_name"] database = pypelib.get_avalon_database() asset_name = entity["parent"]["name"] asset_document = database[project_name].find_one({ "type": "asset", "name": asset_name }) hierarchy = "" asset_doc_parents = asset_document["data"].get("parents") if len(asset_doc_parents) > 0: hierarchy = os.path.join(*asset_doc_parents) application = avalon.lib.get_application(self.identifier) data = { "project": { "name": entity["project"]["full_name"], "code": entity["project"]["name"] }, "task": entity["name"], "asset": asset_name, "app": application["application_dir"], "hierarchy": hierarchy } try: anatomy = Anatomy(project_name) anatomy_filled = anatomy.format(data) workdir = os.path.normpath(anatomy_filled["work"]["folder"]) except Exception as exc: msg = "Error in anatomy.format: {}".format(str(exc)) self.log.error(msg, exc_info=True) return {"success": False, "message": msg} try: os.makedirs(workdir) except FileExistsError: pass # set environments for Avalon prep_env = copy.deepcopy(os.environ) prep_env.update({ "AVALON_PROJECT": project_name, "AVALON_ASSET": asset_name, "AVALON_TASK": entity["name"], "AVALON_APP": self.identifier.split("_")[0], "AVALON_APP_NAME": self.identifier, "AVALON_HIERARCHY": hierarchy, "AVALON_WORKDIR": workdir }) prep_env.update(anatomy.roots_obj.root_environments()) # collect all parents from the task parents = [] for item in entity['link']: parents.append(session.get(item['type'], item['id'])) # collect all the 'environment' attributes from parents tools_attr = [prep_env["AVALON_APP"], prep_env["AVALON_APP_NAME"]] tools_env = asset_document["data"].get("tools_env") or [] tools_attr.extend(tools_env) tools_env = acre.get_tools(tools_attr) env = acre.compute(tools_env) env = acre.merge(env, current_env=dict(prep_env)) env = acre.append(dict(prep_env), env) # Get path to execute st_temp_path = os.environ["PYPE_CONFIG"] os_plat = platform.system().lower() # Path to folder with launchers path = os.path.join(st_temp_path, "launchers", os_plat) # Full path to executable launcher execfile = None if application.get("launch_hook"): hook = application.get("launch_hook") self.log.info("launching hook: {}".format(hook)) ret_val = pypelib.execute_hook(application.get("launch_hook"), env=env) if not ret_val: return { 'success': False, 'message': "Hook didn't finish successfully {0}".format(self.label) } if sys.platform == "win32": for ext in os.environ["PATHEXT"].split(os.pathsep): fpath = os.path.join(path.strip('"'), self.executable + ext) if os.path.isfile(fpath) and os.access(fpath, os.X_OK): execfile = fpath break # Run SW if was found executable if execfile is None: return { "success": False, "message": "We didn't find launcher for {0}".format(self.label) } popen = avalon.lib.launch(executable=execfile, args=[], environment=env) elif (sys.platform.startswith("linux") or sys.platform.startswith("darwin")): execfile = os.path.join(path.strip('"'), self.executable) if not os.path.isfile(execfile): msg = "Launcher doesn't exist - {}".format(execfile) self.log.error(msg) return {"success": False, "message": msg} try: fp = open(execfile) except PermissionError as perm_exc: msg = "Access denied on launcher {} - {}".format( execfile, perm_exc) self.log.exception(msg, exc_info=True) return {"success": False, "message": msg} fp.close() # check executable permission if not os.access(execfile, os.X_OK): msg = "No executable permission - {}".format(execfile) self.log.error(msg) return {"success": False, "message": msg} # Run SW if was found executable if execfile is None: return { "success": False, "message": "We didn't found launcher for {0}".format(self.label) } popen = avalon.lib.launch( # noqa: F841 "/usr/bin/env", args=["bash", execfile], environment=env) # Change status of task to In progress presets = config.get_presets()["ftrack"]["ftrack_config"] if "status_update" in presets: statuses = presets["status_update"] actual_status = entity["status"]["name"].lower() already_tested = [] ent_path = "/".join([ent["name"] for ent in entity["link"]]) while True: next_status_name = None for key, value in statuses.items(): if key in already_tested: continue if actual_status in value or "_any_" in value: if key != "_ignore_": next_status_name = key already_tested.append(key) break already_tested.append(key) if next_status_name is None: break try: query = "Status where name is \"{}\"".format( next_status_name) status = session.query(query).one() entity["status"] = status session.commit() self.log.debug("Changing status to \"{}\" <{}>".format( next_status_name, ent_path)) break except Exception: session.rollback() msg = ("Status \"{}\" in presets wasn't found" " on Ftrack entity type \"{}\"").format( next_status_name, entity.entity_type) self.log.warning(msg) return {"success": True, "message": "Launching {0}".format(self.label)}