Bigtable: create snippets.py for python docs. #6012

sangramql · 2018-09-18T21:19:34Z

No description provided.

tseaver

We need to add support for testing the snippets. See bigquery/nox.py for an example.

tseaver

Are you actually running the snippets yourself? They don't pass for me.

bigtable/nox.py

 @nox.session
 def lint(session):
    """Run linters.
-
+ 


docs/bigtable/snippets.py

+    client = bigtable.Client(project='my-project', admin=True)
+    for example in _find_examples():
+        to_delete = []
+        print '%-25s: %s' % _name_and_doc(example)


tseaver

OK, the changes today look right to me. However, I'm pretty sure that they won't pass. Have you run nox -e snippets to check?

sduskis · 2018-10-15T15:35:43Z

@sumit-ql, can you please update bigtable/nox.py?

tseaver · 2018-10-15T15:59:32Z

@sduskis

@sumit-ql, can you please update bigtable/nox.py?

After #6175, the new location is bigtable/noxfile.py.

sangramql · 2018-10-18T02:19:56Z

Working on fixing the tests, there are dependency failures.

tseaver · 2018-10-18T14:45:37Z

@sangramql The file nox.py has been replaced with noxfile.py. To resolve conflicts, please merge the current master into your branch, and re-apply the snippets session there.

You will need to update Nox via:

$ /path/to/venv/bin/pip uninstall nox-automation
$ /path/to/venv/bin/pip install nox

bigtable/nox.py


 @nox.session
-@nox.parametrize('py', ['2.7', '3.6'])
+@nox.parametrize('py', ['2.7'])


docs/bigtable/snippets.py


 @pytest.fixture(scope='module')
 def client():
-    return bigtable.Client(project='my-project', admin=True)
+    return bigtable.Client(project='grass-clump-479', admin=True)


docs/bigtable/snippets.py

@@ -47,6 +51,7 @@ def to_delete():
        item.delete()


+@pytest.mark.order1


sangramql · 2018-10-24T14:32:32Z

Hi @tseaver , Fixed the tests, could you please review it.

sduskis · 2018-10-24T15:40:48Z

@sumit-ql, it looks like there's a CircleCI failure:

sphinx.errors.SphinxWarning: /var/code/gcp/docs/index.rst:1:toctree contains reference to nonexisting document 'bigtable/index'

Warning, treated as error:
/var/code/gcp/docs/index.rst:1:toctree contains reference to nonexisting document 'bigtable/index'

sangramql · 2018-10-24T17:46:38Z

Hi @tseaver , Fixed the tests, could you please review it.

sangramql · 2018-10-24T17:47:58Z

@tseaver can you suggest the help on this failure. index link is failing for some files, but looks like passing for some. Do we need to change all the links?

tseaver · 2018-10-24T19:28:37Z

@sangramql Since PR #6014, docs/bigtable has been a symlink to bigtable/docs, which does include index.rst. Maybe you need to rebase your create_snippet branch on the current master?

sangramql · 2018-10-25T16:27:43Z

@tseaver, my bad, i removed the symlink while submitting the code, can you please review the code.
@AVaksman thank you for all your help in fixing the tests, can you also review the submitted code.

bigtable/docs/snippets.py

+PRODUCTION = enums.Instance.Type.PRODUCTION
+SERVER_NODES = 3
+STORAGE_TYPE = enums.StorageType.SSD
+LABEL_KEY = u'python-system'


bigtable/docs/snippets.py

+
+    # Assuming that there is an existing instance with `INSTANCE_ID`
+    # on the server already.
+    # to create an instance see 'link'


bigtable/docs/snippets.py

+    operation.result(timeout=100)
+    # [END bigtable_create_cluster]
+    cluster2 = instance.cluster(cluster_id)
+    assert cluster2.exists()


bigtable/docs/snippets.py

+    assert instances_list.__len__() is not 0
+
+
+def test_bigtable_list_clusters():


bigtable/docs/snippets.py

+    client = Client(admin=True)
+    instance = client.instance(INSTANCE_ID)
+    (clusters_list, failed_locations_list) = instance.list_clusters()
+    # [END bigtable_list_clusters]


bigtable/google/cloud/bigtable/client.py

+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]


bigtable/google/cloud/bigtable/client.py

+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]
+            :end-before: [END bigtable_list_clusters]


bigtable/google/cloud/bigtable/instance.py

+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]


bigtable/google/cloud/bigtable/instance.py

+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]
+            :end-before: [END bigtable_list_clusters]


AVaksman · 2018-10-25T19:50:25Z

@sangramql Please also add snippets for methods,

app_profile
list_app_profiles
get_iam_policy
set_iam_policy
test_iam_permissions
to complete examplese for client'.py, cluster.py and instance.py

tseaver · 2018-10-25T21:51:33Z

Unrelated Bigtable lint error, fixed in #6309.

Similar unrelated Firestore lint error (why is it even running?), which will be fixed via #6291.

tseaver · 2018-10-25T22:06:55Z

@sangramql Thanks for sticking with this PR! If you can address the suggestions / requested new snippets from @AVaksman, I think we'll be ready to merge.

sangramql · 2018-10-26T22:34:07Z

@tseaver, @AVaksman ,
I have fixed the review comments, requesting to please review.
I was not able to add get_iam_policy and set_iam_policy as those test failure due to insufficient permissions. If needed I can add to snippets in separate PR, as those already have code in documentations as of now.

tseaver · 2018-10-29T17:21:33Z

@sangramql I'm pretty sure that if you can create an instance, you should be able to call get_iam_policy / set_iam_policy / test_iam_permissions on it.

The only other missing snippet that I see requested by @AVaksman is for instance.update.

sangramql · 2018-10-29T17:51:27Z

@tseaver , @AVaksman Please review the updated code with all the reviews implemented.

tseaver · 2018-10-29T18:03:45Z

@sangramql we still need snippets for instance.update and instance.test_iam_permissions.

sangramql · 2018-10-29T18:08:13Z

@tseaver , @AVaksman added the snippet for get and set iam policy.
Please review.

sangramql · 2018-10-29T18:29:52Z

@sangramql we still need snippets for instance.update and instance.test_iam_permissions.

Added snippets for both the methods. update line 258 and iam_permissions line 360.

sangramql added 4 commits September 13, 2018 22:11

Adding snippets examples

e8b7e72

update snippets.py

97fe27d

Update snippets.py

44fc05c

Update snippets.py

c00c76a

sangramql requested review from dhermes, theacodes and tseaver as code owners September 18, 2018 21:19

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 18, 2018

Update snippets.py

eaf24da

tseaver added documentation api: bigtable Issues related to the Bigtable API. labels Sep 18, 2018

tseaver suggested changes Sep 18, 2018

View reviewed changes

tseaver removed the request for review from dhermes September 18, 2018 22:03

tseaver changed the title ~~Create snippets.py for python docs.~~ Bigtable: create snippets.py for python docs. Sep 18, 2018

sangramql added 2 commits September 26, 2018 21:33

add support for testing the snippets.

30b7640

add support for testing the snippets.

558b48b

tseaver suggested changes Sep 27, 2018

View reviewed changes

Update snippets.py to test using pytest

9bc57fa

tseaver reviewed Oct 2, 2018

View reviewed changes

sduskis removed the request for review from theacodes October 8, 2018 18:04

updating snippets

31eb414

sangramql requested a review from crwilcox as a code owner October 18, 2018 17:25

JustinBeckwith added type: docs Improvement to the documentation for an API. and removed documentation labels Oct 18, 2018

tseaver reviewed Oct 18, 2018

View reviewed changes

merge master

638bec9

Update snippets to fix tests

6e4f1e0

sangramql added 2 commits October 25, 2018 21:42

add deleted symlink

473fab4

fixed the symlink again

c4d4da5

tseaver added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 25, 2018

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 25, 2018

AVaksman reviewed Oct 25, 2018

View reviewed changes

Fix the code as per review for snippets

45a37a2

Added quite flag while running tests

b8079ab

add get and set iam policy

100f518

add snippet example link in instance.py for get and set iam policy

64a8aa4

tseaver approved these changes Oct 29, 2018

View reviewed changes

tseaver merged commit a7d8058 into googleapis:master Oct 29, 2018

sangramql deleted the create_snippet branch October 30, 2018 14:06

		@@ -47,6 +51,7 @@ def to_delete():
		item.delete()


		@pytest.mark.order1

		assert instances_list.__len__() is not 0


		def test_bigtable_list_clusters():

Bigtable: create snippets.py for python docs. #6012

Bigtable: create snippets.py for python docs. #6012

Conversation

sangramql commented Sep 18, 2018

tseaver left a comment

Choose a reason for hiding this comment

tseaver left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

tseaver left a comment

Choose a reason for hiding this comment

sduskis commented Oct 15, 2018 • edited by tseaver Loading

tseaver commented Oct 15, 2018

sangramql commented Oct 18, 2018

tseaver commented Oct 18, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

sangramql commented Oct 24, 2018

sduskis commented Oct 24, 2018

sangramql commented Oct 24, 2018

sangramql commented Oct 24, 2018

tseaver commented Oct 24, 2018

sangramql commented Oct 25, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

AVaksman commented Oct 25, 2018 • edited Loading

tseaver commented Oct 25, 2018

tseaver commented Oct 25, 2018

sangramql commented Oct 26, 2018

tseaver commented Oct 29, 2018 • edited Loading

sangramql commented Oct 29, 2018

tseaver commented Oct 29, 2018

sangramql commented Oct 29, 2018

sangramql commented Oct 29, 2018 • edited Loading

sduskis commented Oct 15, 2018 •

edited by tseaver

Loading

AVaksman commented Oct 25, 2018 •

edited

Loading

tseaver commented Oct 29, 2018 •

edited

Loading

sangramql commented Oct 29, 2018 •

edited

Loading