[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90572=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90572 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 20:43 Start Date: 12/Apr/18 20:43 Worklog Time Spent: 10m Work Description: melap commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380938273 good question -- it looks like the changes are up on the website too, so I am unsure what that error means. @jasonkuster or @alanmyrvold should we just ignore this error? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90572) Time Spent: 3h 50m (was: 3h 40m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 3h 50m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90514=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90514 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 17:59 Start Date: 12/Apr/18 17:59 Worklog Time Spent: 10m Work Description: aaltay commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380892632 @melap I see the merged commit in the repository (https://gitbox.apache.org/repos/asf?p=beam-site.git;a=log;h=refs/heads/asf-site). Do we need to take action to resolve the latest error message from the merge bot? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90514) Time Spent: 3h 40m (was: 3.5h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 3h 40m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90512=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90512 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 17:49 Start Date: 12/Apr/18 17:49 Worklog Time Spent: 10m Work Description: asfgit commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380889825 Error: Adding files from repository preparation failed. Please try again. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90512) Time Spent: 3.5h (was: 3h 20m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 3.5h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[
https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90509=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90509
]
ASF GitHub Bot logged work on BEAM-3985:
Author: ASF GitHub Bot
Created on: 12/Apr/18 17:45
Start Date: 12/Apr/18 17:45
Worklog Time Spent: 10m
Work Description: asfgit closed pull request #412: [BEAM-3985] Document
Gradle commands for testing and linting.
URL: https://github.com/apache/beam-site/pull/412
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/src/contribute/contribution-guide.md
b/src/contribute/contribution-guide.md
index 51456b57a6..68cb082d12 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -176,9 +176,9 @@ changes.
You are now ready to start developing!
- [Python SDK Only] Set up a virtual environemt
+ [Python SDK Only] Set up a virtual environment
-We recommend setting up a virtual envioment for developing Python SDK. Please
+We recommend setting up a virtual environment for developing Python SDK. Please
see instructions available in [Quickstart (Python)]({{ site.baseurl
}}/get-started/quickstart-py/) for setting up a virtual environment.
@@ -218,64 +218,68 @@ push. You'll run:
$ git push --force
-### Building
-
- Python SDK
-
-Before testing SDK code changes remotely, you must build the Beam tarball. From
-the root of the git repository, run:
-
-```
-cd sdks/python/
-python setup.py sdist
-```
-
-Pass the `--sdk_location` flag to use the newly built version. For example:
-
-```
-python setup.py sdist > /dev/null && \
-python -m apache_beam.examples.wordcount ... \
---sdk_location dist/apache-beam-2.5.0.dev0.tar.gz
-```
-
### Testing
All code should have appropriate unit testing coverage. New code should have
new tests in the same contribution. Bug fixes should include a regression test
to prevent the issue from reoccurring.
- Java SDK
+The entire set of tests can be run with this command at the root of the git
+repository.
-For contributions to the Java code, run checks locally via Gradle.
+$ ./gradlew check --rerun-tasks
-$ ./gradlew :beam-sdks-java-core:check --rerun-tasks
+You can also limit tests to certain language SDKs.
+
+$ ./gradlew beam-sdks-java-core:check --rerun-tasks
+$ ./gradlew beam-sdks-python:check --rerun-tasks
+$ ./gradlew beam-sdks-go:check --rerun-tasks
Python SDK
-For contributions to the Python code, you can use command given below to run
-unit tests locally. If you update any of the [cythonized](http://cython.org)
-files in Python SDK, you must install "cython" package before running following
+For contributions to the Python code, you can use the commands below to run
unit
+tests locally. The above Gradle commands should also work, but these commands
+may run faster for you.
+
+If you update any of the [cythonized](http://cython.org)
+files in Python SDK, you must install the `cython` package before running
following
command to properly test your code. We recommend setting up a virtual
environment before testing your code.
-$ python setup.py test
+The following commands should be run in the `sdks/python` directory.
+This command runs all Python tests.
+
+$ python setup.py nosetests
You can use following command to run a single test method.
-$ python setup.py test -s ..
+$ python setup.py nosetests --tests :.
+
+Example:
+$ python setup.py nosetests --tests
apache_beam.io.textio_test:TextSourceTest.test_progress
-To Check for lint errors locally, install "tox" package and run following
-command.
+To check just for lint errors, run the following command.
-$ pip install tox
-$ tox -e py27-lint,py3-lint
+$ ../../gradlew lint
+# Remote testing
-Beam supports running Python SDK tests using Gradle. For this, navigate to root
-directory of your Apache Beam clone and execute following command. Currently
-this cannot be run from a virtual environment.
+This step is only required for testing SDK code changes remotely (not using
+directrunner). In order to do this you must build the Beam tarball. From the
+root of the git repository, run:
+
+```
+$ cd sdks/python/
+$ python setup.py sdist
+```
-$ ./gradlew :beam-sdks-python:check --rerun-tasks
+Pass the `--sdk_location` flag to use the newly built version. For example:
+
+```
+$ python setup.py sdist > /dev/null && \
+python -m apache_beam.examples.wordcount ... \
+--sdk_location dist/apache-beam-2.5.0.dev0.tar.gz
+```
## Review
@@ -307,7 +311,7 @@ following format:
[BEAM-]
-Please include
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90506=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90506 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 17:40 Start Date: 12/Apr/18 17:40 Worklog Time Spent: 10m Work Description: aaltay commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380887224 @asfgit merge This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90506) Time Spent: 3h 10m (was: 3h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 3h 10m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90505=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90505 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 17:40 Start Date: 12/Apr/18 17:40 Worklog Time Spent: 10m Work Description: aaltay commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380887182 Thank you @udim. LGTM. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90505) Time Spent: 3h (was: 2h 50m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 3h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90499=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90499 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 17:27 Start Date: 12/Apr/18 17:27 Worklog Time Spent: 10m Work Description: udim commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380883350 Rebased. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90499) Time Spent: 2h 50m (was: 2h 40m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2h 50m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=90477=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-90477 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 12/Apr/18 16:36 Start Date: 12/Apr/18 16:36 Worklog Time Spent: 10m Work Description: aaltay commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-380867980 @udim Could you rebase and update this PR. Is this still relevant after #414? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 90477) Time Spent: 2h 40m (was: 2.5h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2h 40m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=89651=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-89651 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 10/Apr/18 22:10 Start Date: 10/Apr/18 22:10 Worklog Time Spent: 10m Work Description: udim commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r180582145 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test Review comment: Replaced with check, which includes lint (on some SDKs). I replaced the precommit tasks below with *:check, for language SDKs that had them (I don't know if there's a Java check task for all parts of the Java SDK). This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 89651) Time Spent: 2.5h (was: 2h 20m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2.5h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=89650=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-89650 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 10/Apr/18 22:10 Start Date: 10/Apr/18 22:10 Worklog Time Spent: 10m Work Description: udim commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r180580722 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test -$ mvn clean verify +Run this command to test for lint errors. + +$ ./gradlew lint + +You can also limit tests to certain language SDKs. + +$ ./gradlew javaPreCommit Review comment: Removed javaPreCommit This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 89650) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2h 20m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=89649=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-89649 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 10/Apr/18 22:10 Start Date: 10/Apr/18 22:10 Worklog Time Spent: 10m Work Description: udim commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r180580669 ## File path: src/contribute/contribution-guide.md ## @@ -264,18 +276,9 @@ You can use following command to run a single test method. $ python setup.py test -s .. -To Check for lint errors locally, install "tox" package and run following -command. - -$ pip install tox -$ tox -e lint_py2,lint_py3 - - -Beam supports running Python SDK tests using Maven. For this, navigate to root -directory of your Apache Beam clone and execute following command. Currently -this cannot be run from a virtual environment. +To Check for lint errors locally, run the following command. -$ mvn clean verify -pl sdks/python +$ ../../gradlew lint Review comment: done. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 89649) Time Spent: 2h 20m (was: 2h 10m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2h 20m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=89648=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-89648 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 10/Apr/18 22:10 Start Date: 10/Apr/18 22:10 Worklog Time Spent: 10m Work Description: udim commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r180581708 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test -$ mvn clean verify +Run this command to test for lint errors. + +$ ./gradlew lint Review comment: Removed. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 89648) Time Spent: 2h 10m (was: 2h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 2h 10m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=89019=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-89019 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 09/Apr/18 17:00 Start Date: 09/Apr/18 17:00 Worklog Time Spent: 10m Work Description: lukecwik commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r180162855 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test -$ mvn clean verify +Run this command to test for lint errors. + +$ ./gradlew lint + +You can also limit tests to certain language SDKs. + +$ ./gradlew javaPreCommit Review comment: These precommits typically need more like a GCP account since they run wordcount against Dataflow. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 89019) Time Spent: 1h 50m (was: 1h 40m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1h 50m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88608=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88608 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 20:56 Start Date: 06/Apr/18 20:56 Worklog Time Spent: 10m Work Description: youngoli commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379375704 @udim You're probably right about the `./gradlew clean` being unnecessary. I only had it there because it was mentioned in the original code with `mvn clean verify`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88608) Time Spent: 1h 40m (was: 1.5h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1h 40m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88603=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88603 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 20:41 Start Date: 06/Apr/18 20:41 Worklog Time Spent: 10m Work Description: youngoli commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r179870676 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test Review comment: Perhaps adding some instructions for calling unit tests on certain languages may be useful. This is slightly different than the precommit info down below because it is only unit tests. Examples: ``` $ ./gradlew sdks:java:test $ ./gradlew sdks:python:test $ ./gradlew sdks:go:test ``` Also may be worth using the "check" task instead of "test". According to the gradle docs: > It is common for all verification tasks, including tests and linting, to be executed using the check task. ([Source](https://docs.gradle.org/current/userguide/command_line_interface.html#_running_all_checks)) I don't know if Beam is doing this at the moment, but I feel like this area of the code should mention using check for more intense checks (i.e. for replacing mvn verify), while test is better for basic unit tests. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88603) Time Spent: 1.5h (was: 1h 20m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1.5h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88597=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88597 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 20:28 Start Date: 06/Apr/18 20:28 Worklog Time Spent: 10m Work Description: youngoli commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r179867936 ## File path: src/contribute/contribution-guide.md ## @@ -244,16 +244,28 @@ All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring. - Java SDK +The entire set of unit tests can be run with this command at the root of the +git repository. -For contributions to the Java code, run unit tests locally via Maven. +$ ./gradlew test -$ mvn clean verify +Run this command to test for lint errors. + +$ ./gradlew lint Review comment: I don't think this needs to be mentioned here since the lint task only lints the Python code right now. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88597) Time Spent: 1h 20m (was: 1h 10m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1h 20m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88596=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88596 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 20:21 Start Date: 06/Apr/18 20:21 Worklog Time Spent: 10m Work Description: udim commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379366509 Sorry for not coordinating with you @youngoli, let's merge #414 first and I'll deal with the conflicts in mine. BTW, what do you think of my suggestions for running tests and lint? I don't believe that running `clean` first is necessary, but I might be wrong. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88596) Time Spent: 1h 10m (was: 1h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1h 10m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88561=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88561 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 18:39 Start Date: 06/Apr/18 18:39 Worklog Time Spent: 10m Work Description: youngoli commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379340982 So I didn't realize you were working on this. I made some overlapping changes in my PR #414, so one of us will probably need to merge the changes. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88561) Time Spent: 1h (was: 50m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 1h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88551=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88551 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 18:30 Start Date: 06/Apr/18 18:30 Worklog Time Spent: 10m Work Description: melap commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379338408 retest this please This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88551) Time Spent: 50m (was: 40m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 50m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88541=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88541 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 18:08 Start Date: 06/Apr/18 18:08 Worklog Time Spent: 10m Work Description: aaltay commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379332465 Dead link error is ``` - ./.testcontent/contribute/work-in-progress/index.html * External link https://github.com/apache/beam/tree/go-sdk failed: 404 No error ``` @melap does it need to be fixed in this PR? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88541) Time Spent: 40m (was: 0.5h) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 40m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88540=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88540 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 18:06 Start Date: 06/Apr/18 18:06 Worklog Time Spent: 10m Work Description: aaltay commented on a change in pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#discussion_r179834306 ## File path: src/contribute/contribution-guide.md ## @@ -264,18 +276,9 @@ You can use following command to run a single test method. $ python setup.py test -s .. -To Check for lint errors locally, install "tox" package and run following -command. - -$ pip install tox -$ tox -e lint_py2,lint_py3 - - -Beam supports running Python SDK tests using Maven. For this, navigate to root -directory of your Apache Beam clone and execute following command. Currently -this cannot be run from a virtual environment. +To Check for lint errors locally, run the following command. -$ mvn clean verify -pl sdks/python +$ ../../gradlew lint Review comment: Make it clear that ../.. is here because we assume it is being run from the sdks/python directory. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88540) Time Spent: 0.5h (was: 20m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 0.5h > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88299=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88299 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 01:44 Start Date: 06/Apr/18 01:44 Worklog Time Spent: 10m Work Description: udim commented on issue #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412#issuecomment-379125265 R: @melap This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88299) Time Spent: 20m (was: 10m) > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 20m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Work logged] (BEAM-3985) Update developer guide to reference new Python linting enviroments
[ https://issues.apache.org/jira/browse/BEAM-3985?focusedWorklogId=88298=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88298 ] ASF GitHub Bot logged work on BEAM-3985: Author: ASF GitHub Bot Created on: 06/Apr/18 01:43 Start Date: 06/Apr/18 01:43 Worklog Time Spent: 10m Work Description: udim opened a new pull request #412: [BEAM-3985] Document Gradle commands for testing and linting. URL: https://github.com/apache/beam-site/pull/412 Also fixes outdated references to lint_py2 and lint_py3. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 88298) Time Spent: 10m Remaining Estimate: 0h > Update developer guide to reference new Python linting enviroments > -- > > Key: BEAM-3985 > URL: https://issues.apache.org/jira/browse/BEAM-3985 > Project: Beam > Issue Type: Task > Components: sdk-py-core, website >Reporter: holdenk >Assignee: Udi Meiri >Priority: Minor > Time Spent: 10m > Remaining Estimate: 0h > > tox.ini changed, but [https://beam.apache.org/contribute/contribution-guide/] > still references the told envs. -- This message was sent by Atlassian JIRA (v7.6.3#76005)
