forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
apacheGH-38310: [MATLAB] Create the testing guideline document for te…
…sting MATLAB interface (apache#38459) ### Rationale for this change This document is aimed at coaching people on how to write and run tests for the MATLAB interface. This document is helpful to reproduce and address test failures in GitHub Actions CI, and is also helpful to maintain the good quality of MATLAB interface. ### What changes are included in this PR? Created a markdown page under arrow/matlab/doc. ### Are these changes tested? No test needed. ### Are there any user-facing changes? No software change. * Closes: apache#38310 Authored-by: Lei Hou <[email protected]> Signed-off-by: Kevin Gurney <[email protected]>
- Loading branch information
1 parent
f0ef763
commit a17cbc2
Showing
1 changed file
with
144 additions
and
0 deletions.
There are no files selected for viewing
144 changes: 144 additions & 0 deletions
144
matlab/doc/testing_guidelines_for_the_matlab_interface_to_apache_arrow.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # Testing Guidelines for the MATLAB Interface to Apache Arrow | ||
|
|
||
| ## Overview | ||
|
|
||
| The goal of this document is to provide helpful guidelines for testing functionality within the [`matlab` directory](https://github.com/apache/arrow/tree/main/matlab) of the [`apache/arrow`](https://github.com/apache/arrow) repository. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Adding tests to the MATLAB interface helps to ensure quality and verify that the software works as intended. To run the MATLAB interface tests, the following software must be installed locally: | ||
|
|
||
| 1. [MATLAB](https://www.mathworks.com/products/get-matlab.html) | ||
| 2. [MATLAB Interface to Apache Arrow](https://github.com/mathworks/arrow/tree/main/matlab) | ||
|
|
||
| ## Running Tests Locally | ||
|
|
||
| To run the MATLAB interface tests on a local machine, start MATLAB and then `cd` to the directory under `matlab/test` where the test files of interest reside. After changing to the test directory, call the `runtests` command to run your tests: | ||
|
|
||
| ```matlab | ||
| % To run a single test file | ||
| >> runtests(testFileName) % For example: runtests("tArray.m") | ||
| % To run all tests recursively under a test directory | ||
| >> runtests(testFolderName, IncludeSubfolders = true) % For example: runtests('matlab\test', IncludeSubfolders = true) | ||
| ``` | ||
|
|
||
| To learn more about `runtests`, please check [the documentation](https://www.mathworks.com/help/matlab/ref/runtests.html). | ||
|
|
||
| ## Writing Tests | ||
|
|
||
| All tests for the MATLAB interface should use the [MATLAB Class-Based Unit Testing Framework](https://www.mathworks.com/help/matlab/class-based-unit-tests.html) (i.e. they should use [`matlab.unittest.TestCase`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.testcase-class.html)). | ||
|
|
||
| Included below is a simple example of a MATLAB test: | ||
|
|
||
| ```matlab | ||
| classdef tStringArray < matlab.unittest.TestCase | ||
| methods(Test) | ||
| function TestBasicStringArray(testCase) | ||
| % Verify that an `arrow.array.StringArray` can be created from | ||
| % a basic MATLAB `string` array using the `arrow.array` gateway | ||
| % construction function. | ||
| % Create a basic MATLAB `string` array. | ||
| matlabArray = ["A" ,"B", "C"]; | ||
| % Create an `arrow.array.StringArray` from the MATLAB `string` | ||
| % array by using the `arrow.array` gateway construction function. | ||
| arrowArray = arrow.array(matlabArray); | ||
| % Verify the class of `arrowArray` is `arrow.array.StringArray`. | ||
| testCase.verifyEqual(string(class(arrowArray)), "arrow.array.StringArray"); | ||
| % Verify `arrowArray` can be converted back into a MATLAB `string` array. | ||
| testCase.verifyEqual(arrowArray.toMATLAB, ["A"; "B"; "C"]); | ||
| end | ||
| end | ||
| end | ||
| ``` | ||
|
|
||
| More test examples can be found in the `matlab/test` directory. | ||
|
|
||
| ### Testing Best Practices | ||
|
|
||
| - Use descriptive names for your test cases. | ||
| - Focus on testing one software "behavior" in each test case. | ||
| - Test with both "expected" and "unexpected" inputs. | ||
| - Add a comment at the beginning of each test case which describes what the test case is verifying. | ||
| - Treat test code like any other code (i.e. use clear variable names, write helper functions, make use of abstraction, etc.) | ||
| - Follow existing patterns when adding new test cases to an existing test class. | ||
|
|
||
| ## Test Case Design Guidelines | ||
|
|
||
| When adding new tests, it is recommended to, at a minimum, ensure that real-world workflows work as expected. | ||
|
|
||
| If a change cannot be easily tested at the MATLAB interface level (e.g. you would like to test the behavior of a C++ `Proxy` method), consider creating a `Proxy` instance manually from a MATLAB test case and calling relevant methods on the `Proxy`. | ||
|
|
||
| An example of this approach to test C++ `Proxy` code can be found in [`matlab/test/arrow/tabular/tTabularInternal.m`](https://github.com/apache/arrow/blob/main/matlab/test/arrow/tabular/tTabularInternal.m). | ||
|
|
||
| ## Test Organization | ||
|
|
||
| All tests for the MATLAB interface are located under the `matlab/test` directory. | ||
|
|
||
| To make it easy to find the test files which correspond to specific source files, the MATLAB interface tests are organized using the following rules: | ||
|
|
||
| - Source and test directories follow an (approximately) "parallel" structure. For example, the test directory [`test/arrow/array`](https://github.com/apache/arrow/tree/main/matlab/test/arrow/array) contains tests for the source directory [`src/matlab/+arrow/+array`](https://github.com/apache/arrow/tree/main/matlab/src/matlab/%2Barrow/%2Barray). | ||
| - One test file maps to one source file. For example, [`test/arrow/array/tArray.m`](https://github.com/apache/arrow/blob/main/matlab/test/arrow/array/tArray.m) is the test file for [`src/matlab/+arrow/+array/Array.m`](https://github.com/apache/arrow/blob/main/matlab/src/matlab/%2Barrow/%2Barray/Array.m). | ||
| - **Note**: In certain scenarios, it can make sense to diverge from these rules. For example, if a particular class is very complex and contains a lot of divergent functionality (which we generally try to avoid), we might choose to split the testing into several "focused" test files (e.g. one for testing the class display, one for testing the properties, and one for testing the methods). | ||
|
|
||
| ## Continuous Integration (CI) Workflows | ||
|
|
||
| The Apache Arrow project uses [GitHub Actions](https://github.com/features/actions) as its primary [Continuous Integration (CI)](https://en.wikipedia.org/wiki/Continuous_integration) platform. | ||
|
|
||
| Creating a pull request that changes code in the MATLAB interface will automatically trigger [MATLAB CI Workflows](https://github.com/apache/arrow/actions/workflows/matlab.yml) to be run. These CI workflows will run all tests located under the `matlab/test` directory. | ||
|
|
||
| Reviewers will generally expect the MATLAB CI Workflows to be passing successfully before they will consider merging a pull request. | ||
|
|
||
| If you are having trouble understanding CI failures, you can always ask a reviewer or another community member for help. | ||
|
|
||
| ## Code Coverage Goals | ||
|
|
||
| When making changes to the MATLAB interface, please do your best to add tests to cover all changed lines, conditions, and decisions. | ||
|
|
||
| Before making a pull request, please check the code coverage for any changed code. If possible, it can be helpful to explicitly comment on the code coverage in your pull request description. | ||
|
|
||
| Although we strive for high code coverage, it is understood that some code cannot be reasonably tested (e.g. an "un-reachable" branch in a `switch` condition on an enumeration value). | ||
|
|
||
| ### How to Check Code Coverage | ||
|
|
||
| ***Requirement:** MATLAB R2023b or later.* | ||
|
|
||
| To generate a MATLAB code coverage report, the [`ReportCoverageFor`](https://www.mathworks.com/help/matlab/ref/runtests.html#mw_764c9db7-6823-439f-a77d-7fd25a03d20e) name-value pair argument can be supplied to the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) command. Before generating the code coverage report, remember to add your source file directory to the [MATLAB Search Path](https://www.mathworks.com/help/matlab/matlab_env/what-is-the-matlab-search-path.html). | ||
|
|
||
| ```matlab | ||
| >> addpath( genpath(<your local arrow/matlab>) ) % `genpath` is needed to include all subdirectories and add them to MATLAB search path. | ||
| >> runtests(testFilePath/testFolderPath, 'ReportCoverageFor', sourceFilePath/sourceFolderPath, 'IncludeSubfolders', true/false); | ||
| ``` | ||
|
|
||
| Below is an example of running all tests under `matlab/test` and getting the MATLAB code coverage report for all files under `matlab/src/matlab`. | ||
|
|
||
| ```matlab | ||
| >> addpath(genpath("C:\TryCodeCoverage\arrow\matlab")) | ||
| >> runtests('C:\TryCodeCoverage\arrow\matlab\test', 'ReportCoverageFor', 'C:\TryCodeCoverage\arrow\matlab\src\matlab\', 'IncludeSubfolders', true); | ||
| ``` | ||
|
|
||
| ## Tips | ||
|
|
||
| ### Debugging Code Coverage Results | ||
|
|
||
| If the `runtests` command with `RepoCoverageFor` reports confusing or incorrect code coverage results, this could be due to caching or other issues. As a workaround, you can try setting a breakpoint in your source file, and then re-run the tests. This step can be used to verify that your source file is being executed by the tests. |