| # Copyright 2024 The Pigweed Authors |
| # |
| # Licensed 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 |
| # |
| # https://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. |
| """Tests for the buildifier formatter.""" |
| |
| import importlib.resources |
| from pathlib import Path |
| from tempfile import TemporaryDirectory |
| import unittest |
| |
| from format_testing_utils import CapturingToolRunner |
| from pw_presubmit.format.bazel import BuildifierFormatter |
| |
| |
| _TEST_DATA_FILES = importlib.resources.files('pw_presubmit.format.test_data') |
| _TEST_SRC_FILE = _TEST_DATA_FILES / 'bazel_test_data.bazel' |
| _TEST_GOLDEN = _TEST_DATA_FILES / 'bazel_test_data_golden.bazel' |
| _TEST_MALFORMED = _TEST_DATA_FILES / 'malformed_file.txt' |
| |
| |
| class TestBuildifierFormatter(unittest.TestCase): |
| """Tests for the BuildifierFormatter.""" |
| |
| def test_check_file(self): |
| """Tests that a formatting check produces the formatted result.""" |
| tool_runner = CapturingToolRunner() |
| formatter = BuildifierFormatter() |
| formatter.run_tool = tool_runner |
| |
| result = formatter.format_file_in_memory( |
| _TEST_SRC_FILE, _TEST_SRC_FILE.read_bytes() |
| ) |
| self.assertTrue(result.ok) |
| self.assertEqual(result.error_message, None) |
| self.assertMultiLineEqual( |
| result.formatted_file_contents.decode(), _TEST_GOLDEN.read_text() |
| ) |
| |
| self.assertEqual( |
| tool_runner.command_history.pop(0), |
| ' '.join( |
| ( |
| 'buildifier', |
| '--type=build', |
| '--lint=fix', |
| '--warnings=' |
| + ','.join( |
| ( |
| 'load', |
| 'load-on-top', |
| 'native-build', |
| 'same-origin-load', |
| 'out-of-order-load', |
| ) |
| ), |
| ) |
| ), |
| ) |
| |
| def test_check_file_error(self): |
| """Tests that a malformed build file propagates an error.""" |
| |
| tool_runner = CapturingToolRunner() |
| formatter = BuildifierFormatter() |
| formatter.run_tool = tool_runner |
| |
| result = formatter.format_file_in_memory( |
| _TEST_MALFORMED, _TEST_MALFORMED.read_bytes() |
| ) |
| self.assertFalse(result.ok) |
| self.assertEqual(result.formatted_file_contents, b'') |
| self.assertIn('syntax error', result.error_message) |
| |
| self.assertEqual( |
| tool_runner.command_history.pop(0), |
| ' '.join( |
| ( |
| 'buildifier', |
| '--type=default', |
| '--lint=fix', |
| '--warnings=' |
| + ','.join( |
| ( |
| 'load', |
| 'load-on-top', |
| 'native-build', |
| 'same-origin-load', |
| 'out-of-order-load', |
| ) |
| ), |
| ) |
| ), |
| ) |
| |
| def test_fix_file(self): |
| """Tests that formatting is properly applied to files.""" |
| |
| tool_runner = CapturingToolRunner() |
| formatter = BuildifierFormatter() |
| formatter.run_tool = tool_runner |
| |
| with TemporaryDirectory() as temp_dir: |
| file_to_fix = Path(temp_dir) / _TEST_SRC_FILE.name |
| file_to_fix.write_bytes(_TEST_SRC_FILE.read_bytes()) |
| |
| malformed_file = Path(temp_dir) / _TEST_MALFORMED.name |
| malformed_file.write_bytes(_TEST_MALFORMED.read_bytes()) |
| |
| errors = list(formatter.format_files([file_to_fix, malformed_file])) |
| |
| # Should see three separate commands, one where we try to format |
| # the *.bazel files together, and two where we try to format the |
| # .txt file (which is considered an unknown type). |
| self.assertEqual( |
| tool_runner.command_history.pop(0), |
| ' '.join( |
| ( |
| 'buildifier', |
| '--type=build', |
| '--lint=fix', |
| '--warnings=' |
| + ','.join( |
| ( |
| 'load', |
| 'load-on-top', |
| 'native-build', |
| 'same-origin-load', |
| 'out-of-order-load', |
| ) |
| ), |
| str(file_to_fix), |
| ) |
| ), |
| ) |
| |
| self.assertEqual( |
| tool_runner.command_history.pop(0), |
| ' '.join( |
| ( |
| 'buildifier', |
| '--type=default', |
| '--lint=fix', |
| '--warnings=' |
| + ','.join( |
| ( |
| 'load', |
| 'load-on-top', |
| 'native-build', |
| 'same-origin-load', |
| 'out-of-order-load', |
| ) |
| ), |
| str(malformed_file), |
| ) |
| ), |
| ) |
| |
| self.assertEqual( |
| tool_runner.command_history.pop(0), |
| ' '.join( |
| ( |
| 'buildifier', |
| '--type=default', |
| '--lint=fix', |
| '--warnings=' |
| + ','.join( |
| ( |
| 'load', |
| 'load-on-top', |
| 'native-build', |
| 'same-origin-load', |
| 'out-of-order-load', |
| ) |
| ), |
| str(malformed_file), |
| ) |
| ), |
| ) |
| |
| # Check good build file. |
| self.assertMultiLineEqual( |
| file_to_fix.read_text(), _TEST_GOLDEN.read_text() |
| ) |
| |
| # Check malformed file. |
| self.assertEqual(len(errors), 1) |
| malformed_files = [malformed_file] |
| for file_path, error in errors: |
| self.assertIn(file_path, malformed_files) |
| self.assertFalse(error.ok) |
| self.assertIn('syntax error', error.error_message) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |