Merge pull request #34 from jameskochubasas/master

Adding workflow capability to sasctl

Author: Jon Walker

.coverage.jakochsasctl.fsl.sashq-r.openstack.sas.com.31477.236928

@@ -0,0 +1 @@
+!coverage.py: This is a private format, don't read it directly!{"lines":{"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/__init__.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/__main__.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/core.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/exceptions.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/services.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/tasks.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/__init__.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/cas_management.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/concepts.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/data_sources.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/files.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/folders.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/microanalytic_score.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/model_management.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/model_publish.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/model_repository.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/projects.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/sentiment_analysis.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/service.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/text_categorization.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/text_parsing.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/_services/workflow.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/__init__.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/astore.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/cli.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/pymas/__init__.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/pymas/core.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/pymas/ds2.py":[],"/home/centos/jamesfork/python-sasctl/.tox/py37-tests/lib/python3.7/site-packages/sasctl/utils/pymas/python.py":[]}}

src/sasctl/_services/model_management.py

@@ -6,7 +6,6 @@
 
 from .service import Service
 
-
 class ModelManagement(Service):
     """The Model Management API provides basic resources for monitoring
     performance, comparing models, and running workflow processes.
@@ -232,3 +231,104 @@ def execute_performance_definition(self, definition):
 
         return self.post('/performanceTasks/%s' % definition.id)
 
+    def list_model_workflow_definition(self):
+        """List all enabled Workflow Processes to execute on Model Project.
+
+        Returns
+        -------
+        RestObj
+            The list of workflows
+
+        """
+        from .workflow import Workflow
+        wf = Workflow()
+
+        return wf.list_workflow_enableddefinitions()
+
+    def list_model_workflow_prompt(self, workflowName):
+        """List prompt Workflow Processes Definitions.
+
+        Parameters
+        ----------
+        workflowName : str
+            Name or ID of an enabled workflow to retrieve inputs
+
+        Returns
+        -------
+        list
+            The list of prompts for specific workflow
+    
+        """
+        from .workflow import Workflow
+        wf = Workflow()
+        
+        return wf.list_workflow_prompt(workflowName)
+
+
+    def list_model_workflow_executed(self, projectName):
+        """List prompt Workflow Processes Definitions.
+
+        Parameters
+        ----------
+        projectName : str
+            Name of the Project list executed workflow
+
+
+        Returns
+        -------
+        RestObj
+            List of workflows associated to project
+
+        """
+        from .model_repository import ModelRepository
+        mr = ModelRepository()
+
+        project = mr.get_project(projectName)
+
+        return self.get('/workflowProcesses?filter=eq(associations.solutionObjectId,%22'+project['id']+'%22)')
+
+
+    def execute_model_workflow_definition(self, projectName, workflowName, input=None):
+        """Runs specific Workflow Processes Definitions.
+
+        Parameters
+        ----------
+        projectName : str
+            Name of the Project that will execute workflow
+        workflowName : str
+            Name or ID of an enabled workflow to execute
+        input : dict, optional
+            Input values for the workflow for initial workflow prompt
+
+        Returns
+        -------
+        RestObj
+            The executing workflow
+            
+        """
+        from .model_repository import ModelRepository
+        from .workflow import Workflow
+        mr = ModelRepository()
+        wf = Workflow()
+        
+        project = mr.get_project(projectName)
+
+        workflow = wf.run_workflow_definition(workflowName, input=input)
+        
+        #Associations running workflow to model project, note workflow has to be running
+        # THINK ABOUT: do we do a check on status of the workflow to determine if it is still running before associating?
+        
+        input={"processName":workflow['name'],"processId":workflow['id'],"objectType":"MM_Project",
+               "solutionObjectName":projectName,"solutionObjectId":project['id'],
+               "solutionObjectUri":"/modelRepository/projects/"+project['id'],
+               "solutionObjectMediaType":"application/vnd.sas.models.project+json"}
+        
+        #Note, you can get a HTTP Error 404: {"errorCode":74052,"message":"The workflow process for id <> cannot be found.
+        #                                    Associations can only be made to running processes.","details":["correlator:
+        #                                    e62c5562-2b11-45db-bcb7-933200cb0f0a","traceId: 3118c0fb1eb9702d","path:
+        #                                    /modelManagement/workflowAssociations"],"links":[],"version":2,"httpStatusCode":404} 
+        # Which is fine and expected like the Visual Experience.
+        return self.post('/workflowAssociations', json=input,
+                     headers={'Content-Type': 'application/vnd.sas.workflow.object.association+json'})
+
+

src/sasctl/_services/workflow.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+# encoding: utf-8
+#
+# Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+from .service import Service
+
+class Workflow(Service):
+    """The Workflow API provides basic resources for list, prompt details,
+    and running workflow processes.
+    """
+    _SERVICE_ROOT= '/workflow'
+
+
+    def list_workflow_enableddefinitions(self):
+        """List all enabled Workflow Processes Definitions.
+
+        Returns
+        -------
+        RestObj
+            The list of workflows
+
+        """
+
+        #Additional header to fix 400 ERROR Bad Request
+        headers={"Accept-Language": "en-US"}
+        return self.get('/enabledDefinitions', headers=headers)
+        
+    def list_workflow_prompt(self, name):
+        """List prompt Workflow Processes Definitions.
+
+        Parameters
+        ----------
+        name : str
+            Name or ID of an enabled workflow to retrieve inputs
+
+        Returns
+        -------
+        list
+            The list of prompts for specific workflow
+    
+        """
+        
+        ret = self.__find_specific_workflow(name)
+        if ret is None:
+            raise ValueError("No Workflow enabled for %s name or id." % name)
+        
+        if 'prompts' in ret:
+            return ret['prompts']
+        else:
+            # No prompt inputs on workflow
+            return None
+        
+    def run_workflow_definition(self, name, input=None):
+        """Runs specific Workflow Processes Definitions.
+
+        Parameters
+        ----------
+        name : str
+            Name or ID of an enabled workflow to execute
+        input : dict, optional
+            Input values for the workflow for initial workflow prompt
+
+        Returns
+        -------
+        RestObj
+            The executing workflow
+            
+        """
+        
+        workflow = self.__find_specific_workflow(name)
+        if workflow is None:
+            raise ValueError("No Workflow enabled for %s name or id." % name)
+        
+        if input is None:
+            return self.post('/processes?definitionId=' + workflow['id'],
+	                     headers={'Content-Type': 'application/vnd.sas.workflow.variables+json'})
+        if isinstance(input, dict):
+            return self.post('/processes?definitionId=' + workflow['id'], json=input,
+	                     headers={'Content-Type': 'application/vnd.sas.workflow.variables+json'})
+
+    def __find_specific_workflow(self, name):
+        # Internal helper method
+        # Finds a workflow with the name (can be a name or id)
+        # Returns a dict objects of the workflow
+        listendef = self.list_workflow_enableddefinitions()
+        for tmp in listendef:
+            if tmp['name'] == name:
+                return tmp
+            elif tmp['id'] == name:
+                return tmp
+        
+        # Did not find any enabled workflow with name/id
+        return None
+
+

tests/unit/test_model_management.py

@@ -82,4 +82,20 @@ def test_table_prefix_format():
             # Underscores should not be allowed
             _ = mm.create_performance_definition('model',
                                                  'TestLibrary',
-                                                 'invalid_name')
+                                                 'invalid_name')
+
+def test_execute_model_workflow_definition_invalidworkflow():
+
+    PROJECT = RestObj({'name': 'Test Project', 'id': '98765'})
+    WORKFLOWS = [{'name': 'Test W', 'id': '12345'},{'name': 'TestW2', 'id': '98765', 'prompts': [{'id': '98765', 'variableName': 'projectId', 'variableType': 'string'}]}]
+
+    with mock.patch('sasctl._services.workflow.Workflow'
+                    '.list_workflow_enableddefinitions') as list_workflow_enableddefinitions:
+        with mock.patch('sasctl._services.model_repository.ModelRepository'
+                        '.get_project') as get_project:
+            list_workflow_enableddefinitions.return_value = WORKFLOWS
+            get_project.return_value = PROJECT
+            with pytest.raises(ValueError):
+                # Project missing 
+                _ = mm.execute_model_workflow_definition('TestLibrary','badworkflow')
+

tests/unit/test_workflow.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python
+# encoding: utf-8
+#
+# Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+import pytest
+from six.moves import mock
+
+from sasctl import RestObj
+from sasctl._services import workflow 
+
+
+def test_list_workflow_prompt_invalidworkflow():
+
+    WORKFLOWS = [{'name': 'Test W', 'id': '12345'},{'name': 'TestW2', 'id': '98765', 'prompts': [{'id': '98765', 'variableName': 'projectId', 'variableType': 'string'}]}]
+    wf = workflow.Workflow()
+
+    with mock.patch('sasctl._services.workflow.Workflow'
+                    '.list_workflow_enableddefinitions') as list_workflow_enableddefinitions:
+        list_workflow_enableddefinitions.return_value = WORKFLOWS
+        with pytest.raises(ValueError):
+            # Project missing 
+            _ = wf.list_workflow_prompt('bad')
+
+def test_list_workflow_prompt_workflownoprompt():
+
+    WORKFLOWS = [{'name': 'Test W', 'id': '12345'},{'name': 'TestW2', 'id': '98765', 'prompts': [{'id': '98765', 'variableName': 'projectId', 'variableType': 'string'}]}]
+    wf = workflow.Workflow()
+
+    with mock.patch('sasctl._services.workflow.Workflow'
+                    '.list_workflow_enableddefinitions') as list_workflow_enableddefinitions:
+        list_workflow_enableddefinitions.return_value = WORKFLOWS
+
+        #Testing no prompts on workflow with name
+        testresult = wf.list_workflow_prompt('Test W')
+        print(testresult)
+        assert testresult is None
+
+        #Testing no prompts on workflow with id
+        testresult = wf.list_workflow_prompt('12345')
+        print(testresult)
+        assert testresult is None
+
+
+
+def test_list_workflow_prompt_workflowprompt():
+
+    WORKFLOWS = [{'name': 'Test W', 'id': '12345'},{'name': 'TestW2', 'id': '98765', 'prompts': [{'id': '98765', 'variableName': 'projectId', 'variableType': 'string'}]}]
+    wf = workflow.Workflow()
+
+    with mock.patch('sasctl._services.workflow.Workflow'
+                    '.list_workflow_enableddefinitions') as list_workflow_enableddefinitions:
+        list_workflow_enableddefinitions.return_value = WORKFLOWS
+
+        #Testing workflow with id and prompts
+        testresult = wf.list_workflow_prompt('TestW2')
+        print(testresult)
+        assert testresult is not None
+
+
+        #Testing workflow with id and prompts
+        testresult = wf.list_workflow_prompt('98765')
+        print(testresult)
+        assert testresult is not None
+