bzablocki commented on code in PR #27356: URL: https://github.com/apache/beam/pull/27356#discussion_r1300420435
########## sdks/python/apache_beam/yaml/yaml_transform_ut_test.py: ########## @@ -0,0 +1,1049 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import copy +import logging +import unittest + +import yaml + +import apache_beam as beam +from apache_beam import PCollection +from apache_beam.yaml import YamlTransform +from apache_beam.yaml import yaml_provider +from apache_beam.yaml.yaml_provider import InlineProvider +from apache_beam.yaml.yaml_transform import LightweightScope +from apache_beam.yaml.yaml_transform import SafeLineLoader +from apache_beam.yaml.yaml_transform import Scope +from apache_beam.yaml.yaml_transform import chain_as_composite +from apache_beam.yaml.yaml_transform import ensure_errors_consumed +from apache_beam.yaml.yaml_transform import ensure_transforms_have_types +from apache_beam.yaml.yaml_transform import expand_composite_transform +from apache_beam.yaml.yaml_transform import expand_leaf_transform +from apache_beam.yaml.yaml_transform import expand_pipeline +from apache_beam.yaml.yaml_transform import extract_name +from apache_beam.yaml.yaml_transform import identify_object +from apache_beam.yaml.yaml_transform import normalize_inputs_outputs +from apache_beam.yaml.yaml_transform import normalize_source_sink +from apache_beam.yaml.yaml_transform import only_element +from apache_beam.yaml.yaml_transform import pipeline_as_composite +from apache_beam.yaml.yaml_transform import preprocess_flattened_inputs +from apache_beam.yaml.yaml_transform import preprocess_windowing +from apache_beam.yaml.yaml_transform import push_windowing_to_roots + + +class SafeLineLoaderTest(unittest.TestCase): + def test_get_line(self): + pipeline_yaml = ''' + type: composite + input: + elements: input + transforms: + - type: PyMap + name: Square + input: elements + fn: "lambda x: x * x" + - type: PyMap + name: Cube + input: elements + fn: "lambda x: x * x * x" + output: + Flatten + ''' + spec = yaml.load(pipeline_yaml, Loader=SafeLineLoader) + self.assertEqual(SafeLineLoader.get_line(spec['type']), 2) + self.assertEqual(SafeLineLoader.get_line(spec['input']), 4) + self.assertEqual(SafeLineLoader.get_line(spec['transforms'][0]), 6) + self.assertEqual(SafeLineLoader.get_line(spec['transforms'][0]['type']), 6) + self.assertEqual(SafeLineLoader.get_line(spec['transforms'][0]['name']), 7) + self.assertEqual(SafeLineLoader.get_line(spec['transforms'][1]), 10) + self.assertEqual(SafeLineLoader.get_line(spec['output']), 15) + self.assertEqual(SafeLineLoader.get_line(spec['transforms']), "unknown") + + def test_strip_metadata(self): + spec_yaml = ''' + transforms: + - type: PyMap + name: Square + ''' + spec = yaml.load(spec_yaml, Loader=SafeLineLoader) + stripped = SafeLineLoader.strip_metadata(spec['transforms']) + + self.assertFalse(hasattr(stripped[0], '__line__')) + self.assertFalse(hasattr(stripped[0], '__uuid__')) + + def test_strip_metadata_nothing_to_strip(self): + spec_yaml = 'prop: 123' + spec = yaml.load(spec_yaml, Loader=SafeLineLoader) + stripped = SafeLineLoader.strip_metadata(spec['prop']) + + self.assertFalse(hasattr(stripped, '__line__')) + self.assertFalse(hasattr(stripped, '__uuid__')) + + +class LightweightScopeTest(unittest.TestCase): + @staticmethod + def get_spec(): + pipeline_yaml = ''' + - type: PyMap + name: Square + input: elements + fn: "lambda x: x * x" + - type: PyMap + name: PyMap + input: elements + fn: "lambda x: x * x * x" + - type: Filter + name: FilterOutBigNumbers + input: PyMap + keep: "lambda x: x<100" + ''' + return yaml.load(pipeline_yaml, Loader=SafeLineLoader) + + def test_init(self): + spec = self.get_spec() + scope = LightweightScope(spec) + self.assertEqual(len(scope._transforms_by_uuid), 3) + self.assertCountEqual( + list(scope._uuid_by_name.keys()), + ["PyMap", "Square", "Filter", "FilterOutBigNumbers"]) + + def test_get_transform_id_and_output_name(self): + spec = self.get_spec() + scope = LightweightScope(spec) + transform_id, output = scope.get_transform_id_and_output_name("Square") + self.assertEqual(transform_id, spec[0]['__uuid__']) + self.assertEqual(output, None) + + def test_get_transform_id_and_output_name_with_dot(self): + spec = self.get_spec() + scope = LightweightScope(spec) + transform_id, output = \ + scope.get_transform_id_and_output_name("Square.OutputName") + self.assertEqual(transform_id, spec[0]['__uuid__']) + self.assertEqual(output, "OutputName") + + def test_get_transform_id_by_uuid(self): + spec = self.get_spec() + scope = LightweightScope(spec) + transform_id = scope.get_transform_id(spec[0]['__uuid__']) + self.assertEqual(transform_id, spec[0]['__uuid__']) + + def test_get_transform_id_by_unique_name(self): + spec = self.get_spec() + scope = LightweightScope(spec) + transform_id = scope.get_transform_id("Square") + self.assertEqual(transform_id, spec[0]['__uuid__']) + + def test_get_transform_id_by_ambiguous_name(self): + spec = self.get_spec() + scope = LightweightScope(spec) + with self.assertRaisesRegex(ValueError, r'Ambiguous.*PyMap'): + scope.get_transform_id(scope.get_transform_id(spec[1]['name'])) + + def test_get_transform_id_by_unknown_name(self): + spec = self.get_spec() + scope = LightweightScope(spec) + with self.assertRaisesRegex(ValueError, r'Unknown.*NotExistingTransform'): + scope.get_transform_id("NotExistingTransform") + + +def new_pipeline(): + return beam.Pipeline( + options=beam.options.pipeline_options.PipelineOptions( + pickle_library='cloudpickle')) + + +class MainTest(unittest.TestCase): + def get_transform_by_type(self, result, type): + return ([t for t in result['transforms'] if t['type'] == type][0]) + + def get_scope_by_spec(self, p, spec, inputs=None): + if inputs is None: + inputs = {} + spec = yaml.load(spec, Loader=SafeLineLoader) + + scope = Scope( + beam.pvalue.PBegin(p), + inputs, + spec['transforms'], + yaml_provider.standard_providers(), {}) + return scope, spec + + def test_expand_leaf_transform_with_input(self): + with new_pipeline() as p: + spec = ''' + transforms: + - type: Create + elements: [0] + - type: PyMap + input: Create + fn: "lambda x: x*x" + ''' + scope, spec = self.get_scope_by_spec(p, spec) + result = expand_leaf_transform(spec['transforms'][1], scope) + self.assertTrue('out' in result) + self.assertIsInstance(result['out'], beam.PCollection) + self.assertRegex( + str(result['out'].producer.inputs[0]), r"PCollection.*Create/Map.*") + + def test_expand_leaf_transform_without_input(self): + with new_pipeline() as p: + spec = ''' + transforms: + - type: Create + elements: [0] + ''' + scope, spec = self.get_scope_by_spec(p, spec) + result = expand_leaf_transform(spec['transforms'][0], scope) + self.assertTrue('out' in result) + self.assertIsInstance(result['out'], beam.PCollection) + + def test_pipeline_as_composite_with_type_transforms(self): + spec = ''' + type: composite + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = pipeline_as_composite(spec) + + self.assertEqual(result['type'], 'composite') + self.assertEqual(result['name'], None) + + def test_pipeline_as_composite_with_transforms(self): + spec = ''' + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = pipeline_as_composite(spec) + + self.assertEqual(result['type'], 'composite') + self.assertEqual(result['name'], None) + + def test_pipeline_as_composite_list(self): + spec = ''' + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = pipeline_as_composite(spec) + + self.assertEqual(result['type'], 'composite') + self.assertEqual(result['name'], None) + self.assertEqual(result['transforms'], spec) + self.assertTrue('__line__' in result) + self.assertTrue('__uuid__' in result) + + def test_expand_composite_transform_with_name(self): + with new_pipeline() as p: + spec = ''' + type: composite + name: Custom + transforms: + - type: Create + elements: [0,1,2] + output: + Create + + ''' + scope, spec = self.get_scope_by_spec(p, spec) + result = expand_composite_transform(spec, scope) + self.assertRegex( + str(result['output']), r"PCollection.*Custom/Create/Map.*") + + def test_expand_composite_transform_with_name_input(self): + with new_pipeline() as p: + spec = ''' + type: composite + input: elements + transforms: + - type: PyMap + input: input + fn: 'lambda x: x*x' + output: + PyMap + ''' + elements = p | beam.Create(range(3)) + scope, spec = self.get_scope_by_spec(p, spec, + inputs={'elements': elements}) + result = expand_composite_transform(spec, scope) + + self.assertRegex(str(result['output']), r"PCollection.*Composite/Map.*") + + def test_expand_composite_transform_root(self): + with new_pipeline() as p: + spec = ''' + type: composite + transforms: + - type: Create + elements: [0,1,2] + output: + Create + + ''' + scope, spec = self.get_scope_by_spec(p, spec) + result = expand_composite_transform(spec, scope) + self.assertRegex(str(result['output']), r"PCollection.*Create/Map.*") + + def test_chain_as_composite(self): + spec = ''' + type: chain + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = chain_as_composite(spec) + self.assertEqual(result['type'], "composite") + self.assertEqual(result['name'], "Chain") + self.assertEqual(len(result['transforms']), 2) + self.assertEqual(result['transforms'][0]["input"], {}) + self.assertEqual( + result['transforms'][1]["input"], spec['transforms'][0]['__uuid__']) + self.assertEqual(result['output'], spec['transforms'][1]['__uuid__']) + + def test_chain_as_composite_with_wrong_output_type(self): + spec = ''' + type: chain + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + output: + Create + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + with self.assertRaisesRegex(ValueError, r"Explicit output.*last transform"): + chain_as_composite(spec) + + def test_chain_as_composite_with_wrong_output_name(self): + spec = ''' + type: chain + transforms: + - type: Create + name: elements + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + output: + elements + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + with self.assertRaisesRegex(ValueError, r"Explicit output.*last transform"): + chain_as_composite(spec) + + def test_chain_as_composite_with_outputs_override(self): + spec = ''' + type: chain + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + output: + PyMap + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = chain_as_composite(spec) + self.assertEqual( + result['output']['output'], + f"{spec['transforms'][1]['__uuid__']}.PyMap") + + def test_chain_as_composite_with_input(self): + spec = ''' + type: chain + input: + elements + transforms: + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = chain_as_composite(spec) + self.assertEqual(result['transforms'][0]['input'], {"input": "input"}) + + def test_normalize_source_sink(self): + spec = ''' + source: + type: Create + elements: [0,1,2] + transforms: + - type: PyMap + fn: 'lambda x: x*x' + sink: + type: PyMap + fn: "lambda x: x + 41" + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertTrue('sink' not in result) + self.assertEqual(len(result['transforms']), 3) + self.assertEqual(result['transforms'][0], spec['source']) + self.assertEqual(result['transforms'][2], spec['sink']) + + def test_normalize_source_sink_only_source(self): + spec = ''' + source: + type: Create + elements: [0,1,2] + transforms: + - type: PyMap + fn: 'lambda x: x*x' + + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertTrue('sink' not in result) + self.assertEqual(len(result['transforms']), 2) + self.assertEqual(result['transforms'][0], spec['source']) + + def test_normalize_source_sink_only_sink(self): + spec = ''' + transforms: + - type: PyMap + fn: 'lambda x: x*x' + sink: + type: PyMap + fn: "lambda x: x + 41" + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertTrue('sink' not in result) + self.assertEqual(len(result['transforms']), 2) + self.assertEqual(result['transforms'][1], spec['sink']) + + def test_normalize_source_sink_no_source_no_sink(self): + spec = ''' + transforms: + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertTrue('sink' not in result) + self.assertEqual(len(result['transforms']), 1) + + def test_preprocess_source_sink_composite(self): + spec = ''' + type: composite + source: + type: Create + elements: [0,1,2] + transforms: + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertEqual(len(result['transforms']), 2) + + def test_preprocess_source_sink_chain(self): + spec = ''' + type: chain + source: + type: Create + elements: [0,1,2] + transforms: + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertTrue('source' not in result) + self.assertEqual(len(result['transforms']), 2) + + def test_preprocess_source_sink_other(self): + spec = ''' + - type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_source_sink(spec) + self.assertCountEqual(result, spec) + + def test_normalize_inputs_outputs(self): + spec = ''' + type: PyMap + input: [Create1, Create2] + fn: 'lambda x: x*x' + output: Squared + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_inputs_outputs(spec) + self.assertCountEqual(result['input'], {"input": ["Create1", "Create2"]}) + self.assertCountEqual(result['output'], {"output": "Squared"}) + + def test_normalize_inputs_outputs_dict(self): + spec = ''' + type: PyMap + input: [Create1, Create2] + fn: 'lambda x: x*x' + output: + out1: Squared1 + out2: Squared2 + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = normalize_inputs_outputs(spec) + self.assertCountEqual(result['input'], {"input": ["Create1", "Create2"]}) + self.assertCountEqual( + result['output'], { + "out1": "Squared1", "out2": "Squared2" + }) + self.assertTrue("__uuid__" not in result['output']) + self.assertTrue("__line_" not in result['output']) + + def test_identify_object_with_name(self): + spec = ''' + type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = identify_object(spec) + self.assertRegex(result, r"PyMap.*[0-9]") + + def test_identify_object(self): + spec = ''' + argument: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = identify_object(spec) + self.assertRegex(result, r"at.*[0-9]") + + def test_extract_name_by_type(self): + spec = ''' + type: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = extract_name(spec) + self.assertEqual(result, "PyMap") + + def test_extract_name_by_id(self): + spec = ''' + type: PyMap + id: PyMapId + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = extract_name(spec) + self.assertEqual(result, "PyMapId") + + def test_extract_name_by_name(self): + spec = ''' + type: PyMap + name: PyMapName + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = extract_name(spec) + self.assertEqual(result, "PyMapName") + + def test_extract_name_no_name(self): + spec = ''' + transforms: + - arg: PyMap + fn: 'lambda x: x*x' + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + result = extract_name(spec) + self.assertEqual(result, "") + + def test_push_windowing_to_roots(self): + spec = ''' + type: composite + transforms: + - type: Create + elements: [0,1,2] + - type: PyMap + fn: 'lambda x: x*x' + input: Create + windowing: + type: fixed + size: 2 + + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + spec = normalize_inputs_outputs(spec) + spec['transforms'] = [ + normalize_inputs_outputs(t) for t in spec['transforms'] + ] + result = push_windowing_to_roots(spec) + self.assertCountEqual( + result['transforms'][0]['windowing'], spec['windowing']) + self.assertEqual(result['transforms'][0]['__consumed_outputs'], {None}) + self.assertTrue('windowing' not in result['transforms'][1]) + self.assertTrue('__consumed_outputs' not in result['transforms'][1]) + + def test_preprocess_windowing_custom_type(self): + spec = ''' + type: composite + transforms: + - type: CreateTimestamped + name: Create1 + elements: [0, 2, 4] + - type: SumGlobally + input: Create1 + windowing: + type: fixed + size: 4 + output: SumGlobally + ''' + spec = yaml.load(spec, Loader=SafeLineLoader) + spec = normalize_inputs_outputs(spec) + spec['transforms'] = [ + normalize_inputs_outputs(t) for t in spec['transforms'] + ] + + spec_sum = spec['transforms'][1] + # Pass a copy of spec_sum, because preprocess_windowing modifies Review Comment: Now that I simplified the tests to use a yaml representation as an expected output, this is no longer an issue -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
