feat(examples): move examples to a nested WORKSPACE (#337)

This lets users understand the example in isolation. They can copy/paste the example directory and it works correctly. This refactors the existing examples which are quite weak, only really demonstrating pip usage. This makes room for examples demonstrating other features (like protocol buffers) or package managers (like poetry). In a later commit I'll add bazel-integration-testing so we get a test target that confirms the examples build (including their WORKSPACE being self-contained)
bazelbuild · Jul 17, 2020 · bc092e5 · bc092e5
1 parent 2c117e3
commit bc092e5
Show file tree

Hide file tree

Showing 21 changed files with 71 additions and 108 deletions.
diff --git a/.bazelrc b/.bazelrc
@@ -0,0 +1,8 @@
+# For bazel-in-bazel testing
+# Trick bazel into treating BUILD files under examples/* and e2e/* as being regular files
+# This lets us glob() up all the files inside the examples to make them inputs to tests
+# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
+# To update these lines, run this command:
+# sed -i.bak "/^[^#].*--deleted_packages/s#=.*#=$(find examples/*/* \( -name BUILD -or -name BUILD.bazel \) | xargs -n 1 dirname | paste -sd, -)#" .bazelrc && rm .bazelrc.bak
+build --deleted_packages=examples/pip/boto,examples/pip/extras,examples/pip/helloworld
+query --deleted_packages=examples/pip/boto,examples/pip/extras,examples/pip/helloworld
diff --git a/examples/pip/README.md b/examples/pip/README.md
@@ -0,0 +1,5 @@
+# pip example
+
+This shows how you can point Bazel at your requirements.txt file to get dependencies automatically installed.
+
+It also shows how a monorepo might have multiple python packages which each have a separate requirements.txt file.
diff --git a/examples/pip/WORKSPACE b/examples/pip/WORKSPACE
@@ -0,0 +1,41 @@
+workspace(name = "pip_example")
+
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "rules_python",
+    url = "https://github.com/bazelbuild/rules_python/releases/download/0.0.2/rules_python-0.0.2.tar.gz",
+    strip_prefix = "rules_python-0.0.2",
+    sha256 = "b5668cde8bb6e3515057ef465a35ad712214962f0b3a314e551204266c7be90c",
+)
+
+load("@rules_python//python:pip.bzl", "pip_import", "pip_repositories")
+
+pip_repositories()
+
+pip_import(
+    name = "helloworld_deps",
+    requirements = "//helloworld:requirements.txt",
+)
+
+load("@helloworld_deps//:requirements.bzl", _helloworld_install = "pip_install")
+
+_helloworld_install()
+
+pip_import(
+    name = "boto_deps",
+    requirements = "//boto:requirements.txt",
+)
+
+load("@boto_deps//:requirements.bzl", _boto_install = "pip_install")
+
+_boto_install()
+
+pip_import(
+    name = "extras_deps",
+    requirements = "//extras:requirements.txt",
+)
+
+load("@extras_deps//:requirements.bzl", _extras_install = "pip_install")
+
+_extras_install()
diff --git a/examples/boto/BUILD → examples/pip/boto/BUILD b/examples/boto/BUILD → examples/pip/boto/BUILD
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("@examples_boto//:requirements.bzl", "requirement")
-load("//python:defs.bzl", "py_test")
+load("@boto_deps//:requirements.bzl", "requirement")
+load("@rules_python//python:defs.bzl", "py_test")
 
 package(default_visibility = ["//visibility:public"])
 

diff --git a/examples/boto/boto_test.py → examples/pip/boto/boto_test.py b/examples/boto/boto_test.py → examples/pip/boto/boto_test.py
@@ -13,13 +13,18 @@
 # limitations under the License.
 
 import boto3
+import pip
 import unittest
 
 
 class BotoTest(unittest.TestCase):
 
   def test_version(self):
+    # Just the minimal assertion that the boto3 import worked
     self.assertEqual(boto3.__version__, '1.4.7')
+    # Regression test that the pip version is the one requested
+    # see https://github.com/bazelbuild/rules_python/pull/1#discussion_r138349892
+    self.assertEqual(pip.__version__, '9.0.3')
 
 
 if __name__ == '__main__':

diff --git a/examples/boto/requirements.txt → examples/pip/boto/requirements.txt b/examples/boto/requirements.txt → examples/pip/boto/requirements.txt
@@ -2,3 +2,4 @@ boto3==1.4.7
 # Release 0.15 appears to have a broken wheel.
 # See https://github.com/bazelbuild/rules_python/issues/205.
 docutils!=0.15.post1
+pip==9.0.3
diff --git a/examples/extras/BUILD → examples/pip/extras/BUILD b/examples/extras/BUILD → examples/pip/extras/BUILD
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("@examples_extras//:requirements.bzl", "requirement")
-load("//python:defs.bzl", "py_test")
+load("@extras_deps//:requirements.bzl", "requirement")
+load("@rules_python//python:defs.bzl", "py_test")
 
 package(default_visibility = ["//visibility:public"])
 

diff --git a/examples/extras/extras_test.py → examples/pip/extras/extras_test.py b/examples/extras/extras_test.py → examples/pip/extras/extras_test.py
diff --git a/examples/extras/requirements.txt → examples/pip/extras/requirements.txt b/examples/extras/requirements.txt → examples/pip/extras/requirements.txt
diff --git a/examples/extras/version_test.py → examples/pip/extras/version_test.py b/examples/extras/version_test.py → examples/pip/extras/version_test.py
diff --git a/examples/helloworld/BUILD → examples/pip/helloworld/BUILD b/examples/helloworld/BUILD → examples/pip/helloworld/BUILD
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("@examples_helloworld//:requirements.bzl", "requirement")
-load("//python:defs.bzl", "py_library", "py_test")
+load("@helloworld_deps//:requirements.bzl", "requirement")
+load("@rules_python//python:defs.bzl", "py_library", "py_test")
 
 package(default_visibility = ["//visibility:public"])
 

diff --git a/examples/helloworld/helloworld.py → examples/pip/helloworld/helloworld.py b/examples/helloworld/helloworld.py → examples/pip/helloworld/helloworld.py
diff --git a/examples/helloworld/helloworld_test.py → examples/pip/helloworld/helloworld_test.py b/examples/helloworld/helloworld_test.py → examples/pip/helloworld/helloworld_test.py
diff --git a/examples/helloworld/requirements.txt → examples/pip/helloworld/requirements.txt b/examples/helloworld/requirements.txt → examples/pip/helloworld/requirements.txt
diff --git a/examples/version/BUILD b/examples/version/BUILD
diff --git a/examples/version/requirements.txt b/examples/version/requirements.txt
diff --git a/examples/version/version_test.py b/examples/version/version_test.py
diff --git a/experimental/examples/wheel/BUILD b/experimental/examples/wheel/BUILD
@@ -27,7 +27,7 @@ py_library(
         "//experimental/examples/wheel/lib:module_with_data",
         # Example dependency which is not packaged in the wheel
         # due to "packages" filter on py_package rule.
-        "//examples/helloworld",
+        "//tests/load_from_macro:foo",
     ],
 )
 

diff --git a/internal_deps.bzl b/internal_deps.bzl
@@ -110,24 +110,3 @@ def rules_python_internal_deps():
         name = "piptool_deps",
         requirements = "@rules_python//python:requirements.txt",
     )
-
-    examples()
-
-def examples():
-    """Fetches all required dependencies for rules_python examples."""
-    pip_import(
-        name = "examples_helloworld",
-        requirements = "@rules_python//examples/helloworld:requirements.txt",
-    )
-    pip_import(
-        name = "examples_version",
-        requirements = "@rules_python//examples/version:requirements.txt",
-    )
-    pip_import(
-        name = "examples_boto",
-        requirements = "@rules_python//examples/boto:requirements.txt",
-    )
-    pip_import(
-        name = "examples_extras",
-        requirements = "@rules_python//examples/extras:requirements.txt",
-    )
diff --git a/internal_setup.bzl b/internal_setup.bzl
@@ -1,23 +1,4 @@
-"""Setup for rules_python tests, tools, and examples."""
-
-load(
-    "@examples_boto//:requirements.bzl",
-    _boto_install = "pip_install",
-)
-load(
-    "@examples_extras//:requirements.bzl",
-    _extras_install = "pip_install",
-)
-
-# Imports for examples.
-load(
-    "@examples_helloworld//:requirements.bzl",
-    _helloworld_install = "pip_install",
-)
-load(
-    "@examples_version//:requirements.bzl",
-    _version_install = "pip_install",
-)
+"""Setup for rules_python tests and tools."""
 
 # Requirements for building our piptool.
 load(
@@ -26,13 +7,7 @@ load(
 )
 
 def rules_python_internal_setup():
-    """Setup for rules_python tests, tools, and examples."""
+    """Setup for rules_python tests and tools."""
 
     # Requirements for building our piptool.
     _piptool_install()
-
-    # Imports for examples.
-    _helloworld_install()
-    _version_install()
-    _boto_install()
-    _extras_install()
diff --git a/tests/load_from_macro/BUILD b/tests/load_from_macro/BUILD
@@ -21,4 +21,6 @@ py_library(
     name = "foo",
     srcs = ["foo.py"],
     tags = TAGS,
+    # Allow a test to verify an "outside package" doesn't get included
+    visibility = ["//experimental/examples/wheel:__pkg__"],
 )