Skip to content

Commit

Permalink
CHANGE @W-17100565@ FlowTest no longer requires PipX (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jfeingold35
jfeingold35 authored Nov 19, 2024
1 parent 13a61d6 commit d65661b
Show file tree
Hide file tree
Showing 25 changed files with 767 additions and 1,198 deletions.
153 changes: 95 additions & 58 deletions packages/code-analyzer-flowtest-engine/FlowTest/flow_parser/parse.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
"""

from __future__ import annotations
from lxml import etree as ET

import sys

sys.modules['_elementtree'] = None
import xml.etree.ElementTree as ET

from typing import Optional
import logging
Expand All @@ -27,7 +31,7 @@
logger: logging.Logger = logging.getLogger(__name__)


def get_root(path: str) -> ET._Element:
def get_root(path: str) -> ET.Element:
"""Get flow root
Args:
Expand All @@ -37,7 +41,7 @@ def get_root(path: str) -> ET._Element:
the root of the xml file
"""
return ET.parse(path).getroot()
return ET.parse(path, parser=parse_utils.LineNumberingParser()).getroot()


class Parser(FlowParser):
Expand All @@ -59,7 +63,7 @@ class Parser(FlowParser):

def __init__(self, root):
#: XMl root of a single flow
self.root: ET._Element = root
self.root: ET.Element = root

#: current filepath of flow
self.flow_path: str | None = None
Expand All @@ -74,7 +78,7 @@ def __init__(self, root):
self.flow_type: FlowType | None = None

#: frozen set of all elements that have a child of <name> and are thus flow globals
self.all_named_elems: frozenset[ET._Element] | None = None
self.all_named_elems: frozenset[ET.Element] | None = None

#: variables marked 'available for input', as a pair (flow_path, name)
self.input_variables: frozenset[(str, str)] | None = None
Expand All @@ -100,7 +104,7 @@ def get_declared_run_mode(self) -> RunMode:
def get_filename(self) -> str:
return self.flow_path

def get_root(self) -> ET._Element:
def get_root(self) -> ET.Element:
return self.root

def get_literal_var(self) -> VariableType:
Expand All @@ -124,41 +128,47 @@ def get_flow_type(self) -> FlowType:
# Process Builder
# no <start> but <startElementReference>
res = get_by_tag(self.root, 'startElementReference')
if len(res) > 0:
flow_type = FlowType.ProcessBuilder

else:
if len(res) == 0:
res = get_by_tag(self.root, 'start')
assert len(res) != 0
start = res[0]
if len(res) == 0:
# this is an old format record trigger flow
self.flow_type = FlowType.RecordTrigger
return FlowType.RecordTrigger
start = res[0]

# Trigger, record
# <start> has a child <triggerType>
child = get_by_tag(start, 'triggerType')
if len(child) > 0:
flow_type = FlowType.RecordTrigger
# Trigger, record
# <start> has a child <triggerType>
child = get_by_tag(start, 'triggerType')
if len(child) > 0:
flow_type = FlowType.RecordTrigger

elif len(get_by_tag(start, 'schedule')) > 0:
flow_type = FlowType.Scheduled
elif len(get_by_tag(start, 'schedule')) > 0:
flow_type = FlowType.Scheduled

else:
# We couldn't determine flow type by looking at
# <start> elem, so now look at processType elem
pt = get_by_tag(self.root, 'processType')
if len(pt) > 0:
pt = pt[0].text

# Screen
# <processType>Flow and start does not have trigger or schedule
if pt == 'Flow' or len(get_by_tag(self.root, 'screens')) > 0:
flow_type = FlowType.Screen

# AutoLaunched
# Some teams have their own names, e.g. FooAutolaunchedFlow
# Notice this messes up capitalization from normal 'AutoLaunchedFlow'
# there are also recommendation strategies, etc.
else:
flow_type = FlowType.AutoLaunched
else:
# We couldn't determine flow type by looking at
# <start> elem, so now look at processType elem
pt = get_by_tag(self.root, 'processType')
if len(pt) > 0:
pt = pt[0].text

# Screen
# <processType>Flow and start does not have trigger or schedule
if pt == 'Flow' or len(get_by_tag(self.root, 'screens')) > 0:
flow_type = FlowType.Screen

elif pt.lower() == 'workflow':
flow_type = FlowType.Workflow

elif pt.lower() == 'invocableprocess':
flow_type = FlowType.InvocableProcess

# AutoLaunched
# Some teams have their own names, e.g. FooAutolaunchedFlow
# Notice this messes up capitalization from normal 'AutoLaunchedFlow'
# there are also recommendation strategies, etc.
else:
flow_type = FlowType.AutoLaunched

if flow_type is not None:
self.flow_type = flow_type
Expand All @@ -174,7 +184,8 @@ def resolve_by_name(self, name: str, path: str | None = None,
"Account_var.Name" --> ("Account_var", "Name", VariableType)
"account_var" --> (account_var, None, VariableType).
(my_subflow.account.Name) --> (my_subflow.account, Name, VarType)
(my_subflow.account.Name) --> (my_subflow.account, Name, VariableType)
(my_action_call.account) --> (my_action_call.account, None, VariableType)
Args:
name: raw name as it is used in the flow xml file (e.g. foo.bar.baz)
Expand Down Expand Up @@ -206,6 +217,9 @@ def resolve_by_name(self, name: str, path: str | None = None,
if spl_len == 1:
logger.warning(f"RESOLUTION ERROR {name}")
if strict is False:
# 'strict' = False means that any unknown variable name
# is assumed to be a string literal that is hardcoded into
# the flows runtime and so not declared in flow xml file
return name, None, self.literal_var
else:
return None
Expand All @@ -231,7 +245,7 @@ def resolve_by_name(self, name: str, path: str | None = None,

@classmethod
def from_file(cls, filepath: str, old_parser: Parser = None) -> Parser:
root = ET.parse(filepath).getroot()
root = ET.parse(filepath, parser=parse_utils.LineNumberingParser()).getroot()
parser = Parser(root)
parser.flow_path = filepath
parser.update(old_parser=old_parser)
Expand Down Expand Up @@ -300,10 +314,10 @@ def get_input_variables(self, path: str | None = None) -> {(str, str)}:
path = self.flow_path
return {(x, y) for (x, y) in self.input_variables if x == path}

def get_input_field_elems(self) -> set[ET._Element] | None:
def get_input_field_elems(self) -> set[ET.Element] | None:
return parse_utils.get_input_fields(self.root)

def get_input_output_elems(self) -> {str: set[ET._Element]}:
def get_input_output_elems(self) -> {str: set[ET.Element]}:
"""
Returns::
{"input": input variable elements,
Expand All @@ -325,7 +339,7 @@ def get_input_output_elems(self) -> {str: set[ET._Element]}:
"output": output_accum
}

def get_by_name(self, name_to_match: str, scope: ET._Element | None = None) -> ET._Element | None:
def get_by_name(self, name_to_match: str, scope: ET.Element | None = None) -> ET.Element | None:
"""returns the first elem with the given name that is a child of the scope element"""
if name_to_match == '*':
return self.get_start_elem()
Expand Down Expand Up @@ -356,9 +370,17 @@ def get_run_mode(self) -> RunMode:
"""
flow_type = self.get_flow_type()
if flow_type is not FlowType.Screen and flow_type is not FlowType.AutoLaunched:

if flow_type is FlowType.InvocableProcess:
# always runs in user mode
return RunMode.DefaultMode

if flow_type in [FlowType.Workflow, FlowType.RecordTrigger, FlowType.Scheduled, FlowType.ProcessBuilder]:
# always runs in system mode
return RunMode.SystemModeWithoutSharing

# for screen and other autolaunched, check if there is a declaration
# otherwise go with default
elems = get_by_tag(self.root, 'runInMode')
if len(elems) == 0:
return RunMode.DefaultMode
Expand All @@ -368,48 +390,48 @@ def get_run_mode(self) -> RunMode:
def get_api_version(self) -> str:
return get_by_tag(self.root, 'apiVersion')[0].text

def get_all_traversable_flow_elements(self) -> [ET._Element]:
def get_all_traversable_flow_elements(self) -> [ET.Element]:
""" ignore start"""
return [child for child in self.root if
get_tag(child) in ['actionCalls', 'assignments', 'decisions', 'loops',
'recordLookups', 'recordUpdates',
'collectionProcessors', 'recordDeletes', 'recordCreates', 'screens', 'subflows',
'waits', 'recordRollbacks']]

def get_all_variable_elems(self) -> [ET._Element] or None:
def get_all_variable_elems(self) -> [ET.Element] or None:
elems = get_by_tag(self.root, 'variables')
if len(elems) == 0:
return None
else:
return elems

def get_templates(self) -> [ET._Element]:
def get_templates(self) -> [ET.Element]:
"""Grabs all template elements.
Returns empty list if none found
"""
templates = get_by_tag(self.root, 'textTemplates')
return templates

def get_formulas(self) -> [ET._Element]:
def get_formulas(self) -> [ET.Element]:
"""Grabs all formula elements.
Returns empty list if none found
"""
formulas = get_by_tag(self.root, 'formulas')
return formulas

def get_choices(self) -> [ET._Element]:
def get_choices(self) -> [ET.Element]:
choices = get_by_tag(self.root, 'choices')
return choices

def get_dynamic_choice_sets(self) -> [ET._Element]:
def get_dynamic_choice_sets(self) -> [ET.Element]:
dcc = get_by_tag(self.root, 'dynamicChoiceSets')
return dcc

def get_constants(self) -> [ET._Element]:
def get_constants(self) -> [ET.Element]:
constants = get_by_tag(self.root, 'constants')
return constants

def get_start_elem(self) -> ET._Element:
def get_start_elem(self) -> ET.Element:
"""Get first element of flow
Returns:
Expand All @@ -424,10 +446,16 @@ def get_start_elem(self) -> ET._Element:
elif len(res2) == 1:
return self.get_by_name(res2[0].text)

# Put in provision for older flows that are missing start elements but have only
# a single crud element
candidates = get_by_tag(self.root, 'recordUpdates')
if len(candidates) == 1:
return candidates[0]

else:
raise RuntimeError("Currently only flows with a single 'start' or 'startElementReference' can be scanned")

def get_all_indirect_tuples(self) -> list[tuple[str, ET._Element]]:
def get_all_indirect_tuples(self) -> list[tuple[str, ET.Element]]:
"""returns a list of tuples of all indirect references, e.g.
str, elem, where str influences elem.
The elem is a formula or template element and
Expand Down Expand Up @@ -483,13 +511,13 @@ def __get_type(self, name: str, path: str | None = None, strict: bool = False) -

else:
logger.info(f"Auto-resolving {name} in file {self.flow_path}")
if strict is False:
if strict is True:
return self.literal_var
else:
return None


def build_vartype_from_elem(elem: ET._Element) -> VariableType | None:
def build_vartype_from_elem(elem: ET.Element) -> VariableType | None:
"""Build VariableType from XML Element
The purpose of this function is to assign types to named
Expand Down Expand Up @@ -538,6 +566,15 @@ def build_vartype_from_elem(elem: ET._Element) -> VariableType | None:
object_name=parse_utils.get_obj_name(elem),
is_optional=nulls_provided is not None and nulls_provided is False)

if tag == 'actionCalls':
is_ = parse_utils.is_auto_store(elem)
if is_ is True:
reference = ReferenceType.ActionCallReference
# TODO: see if we can get datatype info from return value

return VariableType(tag=tag, datatype=DataType.StringValue,
reference=reference, is_optional=False)

if tag == 'recordCreates':
# Todo: get collection parsing correct, look if record being created is itself
# a collection element - do examples of bulkified versions of commands.
Expand Down Expand Up @@ -640,7 +677,7 @@ def build_vartype_from_elem(elem: ET._Element) -> VariableType | None:
return None


def _get_global_flow_data(flow_path, root: ET._Element) -> ([ET._Element], {str: VariableType}):
def _get_global_flow_data(flow_path, root: ET.Element) -> ([ET.Element], {str: VariableType}):
all_named = get_named_elems(root)

# all named cannot be None, each flow must have at least one named element.
Expand All @@ -655,15 +692,15 @@ def _get_global_flow_data(flow_path, root: ET._Element) -> ([ET._Element], {str:
try:
var = build_vartype_from_elem(x)
except Exception:
logger.error(f"ERROR parsing element {ET.tounicode(x)}")
logger.error(f"ERROR parsing element {ET.tostring(x, encoding='unicode')}")
continue
if var is not None:
vars_[(flow_path, name_dict[x])] = var

if var.is_input and var.is_input is True:
if var.is_input is True:
inputs.append((flow_path, name_dict[x]))

if var.is_output and var.is_output is True:
if var.is_output is True:
outputs.append((flow_path, name_dict[x]))

return all_named, vars_, frozenset(inputs), frozenset(outputs)
Expand Down
Loading

0 comments on commit d65661b

Please sign in to comment.