You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/12/01 14:00:20 UTC
[GitHub] [arrow] AlenkaF opened a new pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
AlenkaF opened a new pull request #11827:
URL: https://github.com/apache/arrow/pull/11827
Add **Testing in Python** section of the New Contributor's guide
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r761753094
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
+
+ To run a specific unit test use this command in
+ the terminal from the ``arrow/python`` folder:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py -k test_your_unit_test
+
+ Run all the tests from one file:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py
+
+ Run all the tests:
+
+ .. code-block::
+
+ python -m pytest pyarrow
+
+ If the tests start failing try to recompile
+ PyArrow or C++.
+
+ .. note::
+
+ **Recompiling Cython**
+
+ If you change only the .py file you do not need to
+ recompile PyArrow. But you have to that if you make
+ changes in .pyx or .pxd files.
+
+ To do that run this command again:
+
+ .. code-block::
+
+ python setup.py build_ext --inplace
+
+ .. note::
+
+ **Recompiling C++**
+
+ Similarly you will need to recompile C++ if you have
+ done some changes in C++ files. In this case
+ re-run the cmake commands again.
Review comment:
Yes, will add them!
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r763814191
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
+
+Adding a new unit tests is needed when adding a new feature,
+a binding or a bug fix.
+
+It can also happen your work will involve adding a unit test
+to a code already written, modifying a unit test or even making
+more than one unit test for the changes in the code.
+
+It is also possible to make changes that do not require adding
+a unit test like :ref:`documentation`.
+
+If you do need to work with unit tests, this section will help
+you with the necessary steps.
Review comment:
Seems reasonable to me ;)
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988479571
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/3367979357364948b806b4effddea141...3c3d490fd75442abb7ff6bb8efa48981/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c63115fda76f476ea15830bd0f9f71f7...b05a4395348740d1b63043bed43d1c94/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/3f5a06e01e5e4147b2f2c20470371283...cfd4bb6d0f964faba4ac826a6f551bb2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r761141305
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
Review comment:
I think it's a good idea to introduce this section, but I think that perhaps this could be rephrased a little. The point being made is an important one, but there are circumstances in which it's not true - if someone is making a change to existing code which requires modifying of existing tests (not adding them), or making a change to a part of the codebase which doesn't involve testing (e.g. documentation, or a listing script, or something else). And it might not be one test - one code change could lead to multiple tests.
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
+
+ To run a specific unit test use this command in
+ the terminal from the ``arrow/python`` folder:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py -k test_your_unit_test
+
+ Run all the tests from one file:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py
+
+ Run all the tests:
+
+ .. code-block::
+
+ python -m pytest pyarrow
+
+ If the tests start failing try to recompile
+ PyArrow or C++.
+
+ .. note::
+
+ **Recompiling Cython**
+
+ If you change only the .py file you do not need to
+ recompile PyArrow. But you have to that if you make
+ changes in .pyx or .pxd files.
Review comment:
```suggestion
If you only make changes to `.py` files, you do not need to
recompile PyArrow. However, you should recompile it if you make
changes in `.pyx` or `.pxd` files.
```
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
+
+ To run a specific unit test use this command in
+ the terminal from the ``arrow/python`` folder:
Review comment:
```suggestion
To run a specific unit test, use this command in
the terminal from the ``arrow/python`` folder:
```
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
+
+ To run a specific unit test use this command in
+ the terminal from the ``arrow/python`` folder:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py -k test_your_unit_test
+
+ Run all the tests from one file:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py
+
+ Run all the tests:
+
+ .. code-block::
+
+ python -m pytest pyarrow
+
+ If the tests start failing try to recompile
+ PyArrow or C++.
Review comment:
```suggestion
If the tests start failing, try to recompile
PyArrow or C++.
```
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
Review comment:
```suggestion
During the development process, it can be more efficient to only run the tests relevant to the code which you are working on. However, you should run all of the tests once you have finished your development work.
```
How about this?
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ What we normally do is run the test we are working on
+ only. Once we are finished with our work and then
+ we run other tests also.
+
+ To run a specific unit test use this command in
+ the terminal from the ``arrow/python`` folder:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py -k test_your_unit_test
+
+ Run all the tests from one file:
+
+ .. code-block::
+
+ python -m pytest pyarrow/tests/test_file.py
+
+ Run all the tests:
+
+ .. code-block::
+
+ python -m pytest pyarrow
+
+ If the tests start failing try to recompile
+ PyArrow or C++.
+
+ .. note::
+
+ **Recompiling Cython**
+
+ If you change only the .py file you do not need to
+ recompile PyArrow. But you have to that if you make
+ changes in .pyx or .pxd files.
+
+ To do that run this command again:
+
+ .. code-block::
+
+ python setup.py build_ext --inplace
+
+ .. note::
+
+ **Recompiling C++**
+
+ Similarly you will need to recompile C++ if you have
+ done some changes in C++ files. In this case
+ re-run the cmake commands again.
Review comment:
```suggestion
Similarly, you will need to recompile the C++ code if you have
made changes to any C++ files. In this case,
re-run the cmake commands again.
```
Would it be worth mentioning the file extensions for C++ files here?
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-983668011
https://issues.apache.org/jira/browse/ARROW-14758
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic closed pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
thisisnic closed pull request #11827:
URL: https://github.com/apache/arrow/pull/11827
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] AlenkaF commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r761737599
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,68 @@
***********
Testing 🧪
***********
+
+In Arrow we always add a unit test to the code we are
+contributing. Therefore you will also need to add one when
+you finish with your work.
Review comment:
Good point! Thanks for pointing this out, will rephrase.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r763771394
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
+
+Adding a new unit tests is needed when adding a new feature,
+a binding or a bug fix.
+
+It can also happen your work will involve adding a unit test
+to a code already written, modifying a unit test or even making
+more than one unit test for the changes in the code.
+
+It is also possible to make changes that do not require adding
+a unit test like :ref:`documentation`.
+
+If you do need to work with unit tests, this section will help
+you with the necessary steps.
Review comment:
Happy for you to push back on this if you disagree, but perhaps we don't need these paragraphs? I'd be tempted to cut all of this out, and just go with something along the lines of "In this section we outline steps needed for unit testing in Arrow".
I think we can probably assume that anyone who is thinking of contributing to Arrow already knows typical software development process steps (including unit testing), and it's only how to do it on this project which is new knowledge to them. It's a huge task to educate people on what to test or not, and I'm not sure we want to take it up! :)
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988479571
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/3367979357364948b806b4effddea141...3c3d490fd75442abb7ff6bb8efa48981/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c63115fda76f476ea15830bd0f9f71f7...b05a4395348740d1b63043bed43d1c94/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/3f5a06e01e5e4147b2f2c20470371283...cfd4bb6d0f964faba4ac826a6f551bb2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988166439
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/753eb17d53aa4c55b7449651d092edae...49d12404ca00449db004008b94fa12f6/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/d9733423cae5465bae7bdc4a6874bd77...0878b127fdda4249803e4821b416adf9/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/a8a6190d334548188ff9b6875f80f07f...cbe528a123874715b18336ff5a72e84b/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988479571
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/3367979357364948b806b4effddea141...3c3d490fd75442abb7ff6bb8efa48981/)
[Finished :arrow_down:1.48% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c63115fda76f476ea15830bd0f9f71f7...b05a4395348740d1b63043bed43d1c94/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/3f5a06e01e5e4147b2f2c20470371283...cfd4bb6d0f964faba4ac826a6f551bb2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot edited a comment on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988479571
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/3367979357364948b806b4effddea141...3c3d490fd75442abb7ff6bb8efa48981/)
[Finished :arrow_down:1.48% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/c63115fda76f476ea15830bd0f9f71f7...b05a4395348740d1b63043bed43d1c94/)
[Finished :arrow_down:0.18% :arrow_up:0.13%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/3f5a06e01e5e4147b2f2c20470371283...cfd4bb6d0f964faba4ac826a6f551bb2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r763778650
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
+
+Adding a new unit tests is needed when adding a new feature,
+a binding or a bug fix.
+
+It can also happen your work will involve adding a unit test
+to a code already written, modifying a unit test or even making
+more than one unit test for the changes in the code.
+
+It is also possible to make changes that do not require adding
+a unit test like :ref:`documentation`.
+
+If you do need to work with unit tests, this section will help
+you with the necessary steps.
+
+.. tabs::
+
+ .. tab:: Pytest
+
+ We use `pytest <https://docs.pytest.org/en/latest/>`_ for
+ unit tests in Python. For more info about the required
+ packages follow
+ :ref:`Python unit testing section <python-unit-testing>`.
+
+ During the development process, it can be more efficient to only run the tests relevant to the code which you are working on. However, you should run all of the tests once you have finished your development work.
Review comment:
On second thoughts, I wonder if this paragraph is needed either? I don't always run all the R tests if I've made a tiny self-contained changed, as I know it's not going to impact anything else, and that the CI is going to run it all and more. Even if this is good advice, I wonder if, given this is a step-by-step guide, it perhaps doesn't belong here.
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
+
+Adding a new unit tests is needed when adding a new feature,
+a binding or a bug fix.
+
+It can also happen your work will involve adding a unit test
+to a code already written, modifying a unit test or even making
+more than one unit test for the changes in the code.
+
+It is also possible to make changes that do not require adding
+a unit test like :ref:`documentation`.
+
+If you do need to work with unit tests, this section will help
+you with the necessary steps.
Review comment:
Happy for you to push back on this if you disagree, but perhaps we don't need these paragraphs? I'd be tempted to cut all of this out, and just go with something along the lines of "In this section we outline steps needed for unit testing in Arrow".
I think we can probably assume that anyone who is thinking of contributing to Arrow already knows typical software development process steps (including unit testing), and it's only how to do it on this project which is new knowledge to them.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#issuecomment-988166439
Benchmark runs are scheduled for baseline = 784c0a18b97f9535d509d70fbe8a6f822d912eff and contender = 3c4ced87511120ee5a945424186b7c56b9b25de8. 3c4ced87511120ee5a945424186b7c56b9b25de8 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/753eb17d53aa4c55b7449651d092edae...49d12404ca00449db004008b94fa12f6/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/d9733423cae5465bae7bdc4a6874bd77...0878b127fdda4249803e4821b416adf9/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/a8a6190d334548188ff9b6875f80f07f...cbe528a123874715b18336ff5a72e84b/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] thisisnic commented on a change in pull request #11827: ARROW-14758: [Doc] Steps in making your first PR - test in Python
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11827:
URL: https://github.com/apache/arrow/pull/11827#discussion_r763761061
##########
File path: docs/source/developers/guide/step_by_step/testing.rst
##########
@@ -29,3 +29,79 @@
***********
Testing 🧪
***********
+
+In Arrow we use unit tests to ensure code quality, to help
+others understand our code better and to make the process
+of review easier.
Review comment:
If we're going to lay out all the important reasons for unit tests here, I think we should mention something about the fact that part of the reason for testing is that we want to make sure that code works across different platforms/operating systems etc.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org