You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by me...@apache.org on 2018/04/12 17:45:01 UTC
[beam-site] branch asf-site updated (6dcda43 -> 6cfd3ba)
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a change to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from 6dcda43 Prepare repository for deployment.
add 29600fd Document Gradle command for testing Beam SDK.
add c7cf51f This closes #412
new 6cfd3ba Prepare repository for deployment.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
content/contribute/contribution-guide/index.html | 80 ++++++++++++-----------
src/contribute/contribution-guide.md | 82 +++++++++++++-----------
2 files changed, 85 insertions(+), 77 deletions(-)
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 01/01: Prepare repository for deployment.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 6cfd3ba360a4862b843864af12b951db29aafd57
Author: Mergebot <me...@apache.org>
AuthorDate: Thu Apr 12 10:44:58 2018 -0700
Prepare repository for deployment.
---
content/contribute/contribution-guide/index.html | 80 +++++++++++++-----------
1 file changed, 42 insertions(+), 38 deletions(-)
diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html
index 5c965df..ff7b90e 100644
--- a/content/contribute/contribution-guide/index.html
+++ b/content/contribute/contribution-guide/index.html
@@ -158,7 +158,6 @@
<li><a href="#one-time-setup">One-time Setup</a></li>
<li><a href="#create-a-branch-in-your-fork">Create a branch in your fork</a></li>
<li><a href="#syncing-and-pushing-your-branch">Syncing and pushing your branch</a></li>
- <li><a href="#building">Building</a></li>
<li><a href="#testing">Testing</a></li>
</ul>
</li>
@@ -353,9 +352,9 @@ changes.</p>
<p>You are now ready to start developing!</p>
-<h4 id="python-sdk-only-set-up-a-virtual-environemt">[Python SDK Only] Set up a virtual environemt</h4>
+<h4 id="python-sdk-only-set-up-a-virtual-environment">[Python SDK Only] Set up a virtual environment</h4>
-<p>We recommend setting up a virtual envioment for developing Python SDK. Please
+<p>We recommend setting up a virtual environment for developing Python SDK. Please
see instructions available in <a href="/get-started/quickstart-py/">Quickstart (Python)</a> for setting up a virtual environment.</p>
<h4 id="optional-ide-setup">[Optional] IDE Setup</h4>
@@ -400,71 +399,76 @@ push. You’ll run:</p>
</code></pre>
</div>
-<h3 id="building">Building</h3>
+<h3 id="testing">Testing</h3>
-<h4 id="python-sdk">Python SDK</h4>
+<p>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.</p>
-<p>Before testing SDK code changes remotely, you must build the Beam tarball. From
-the root of the git repository, run:</p>
+<p>The entire set of tests can be run with this command at the root of the git
+repository.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>cd sdks/python/
-python setup.py sdist
+<div class="highlighter-rouge"><pre class="highlight"><code>$ ./gradlew check --rerun-tasks
</code></pre>
</div>
-<p>Pass the <code class="highlighter-rouge">--sdk_location</code> flag to use the newly built version. For example:</p>
+<p>You can also limit tests to certain language SDKs.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>python setup.py sdist > /dev/null && \
- python -m apache_beam.examples.wordcount ... \
- --sdk_location dist/apache-beam-2.5.0.dev0.tar.gz
+<div class="highlighter-rouge"><pre class="highlight"><code>$ ./gradlew beam-sdks-java-core:check --rerun-tasks
+$ ./gradlew beam-sdks-python:check --rerun-tasks
+$ ./gradlew beam-sdks-go:check --rerun-tasks
</code></pre>
</div>
-<h3 id="testing">Testing</h3>
+<h4 id="python-sdk">Python SDK</h4>
-<p>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.</p>
+<p>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.</p>
-<h4 id="java-sdk">Java SDK</h4>
+<p>If you update any of the <a href="http://cython.org">cythonized</a>
+files in Python SDK, you must install the <code class="highlighter-rouge">cython</code> package before running following
+command to properly test your code. We recommend setting up a virtual
+environment before testing your code.</p>
-<p>For contributions to the Java code, run checks locally via Gradle.</p>
+<p>The following commands should be run in the <code class="highlighter-rouge">sdks/python</code> directory.
+This command runs all Python tests.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ ./gradlew :beam-sdks-java-core:check --rerun-tasks
+<div class="highlighter-rouge"><pre class="highlight"><code>$ python setup.py nosetests
</code></pre>
</div>
-<h4 id="python-sdk-1">Python SDK</h4>
+<p>You can use following command to run a single test method.</p>
-<p>For contributions to the Python code, you can use command given below to run
-unit tests locally. If you update any of the <a href="http://cython.org">cythonized</a>
-files in Python SDK, you must install “cython” package before running following
-command to properly test your code. We recommend setting up a virtual
-environment before testing your code.</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>$ python setup.py nosetests --tests <module>:<test class>.<test method>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ python setup.py test
+Example:
+$ python setup.py nosetests --tests apache_beam.io.textio_test:TextSourceTest.test_progress
</code></pre>
</div>
-<p>You can use following command to run a single test method.</p>
+<p>To check just for lint errors, run the following command.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ python setup.py test -s <module>.<test class>.<test method>
+<div class="highlighter-rouge"><pre class="highlight"><code>$ ../../gradlew lint
</code></pre>
</div>
-<p>To Check for lint errors locally, install “tox” package and run following
-command.</p>
+<h5 id="remote-testing">Remote testing</h5>
+
+<p>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:</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ pip install tox
-$ tox -e py27-lint,py3-lint
+<div class="highlighter-rouge"><pre class="highlight"><code>$ cd sdks/python/
+$ python setup.py sdist
</code></pre>
</div>
-<p>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.</p>
+<p>Pass the <code class="highlighter-rouge">--sdk_location</code> flag to use the newly built version. For example:</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>$ ./gradlew :beam-sdks-python:check --rerun-tasks
+<div class="highlighter-rouge"><pre class="highlight"><code>$ python setup.py sdist > /dev/null && \
+ python -m apache_beam.examples.wordcount ... \
+ --sdk_location dist/apache-beam-2.5.0.dev0.tar.gz
</code></pre>
</div>
@@ -502,7 +506,7 @@ following format:</p>
</code></pre>
</div>
-<p>Please include a descriptive pull request message to help make the comitter’s
+<p>Please include a descriptive pull request message to help make the committer’s
job easier when reviewing. It’s fine to refer to existing design docs or the
contents of the associated JIRA as appropriate.</p>
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.