Add support for RuntimeConfig API. by tswast · Pull Request #2485 · googleapis/google-cloud-python

tswast · 2016-10-03T20:13:00Z

Supports listing and getting variables, but not the other methods of the RuntimeConfig API, since
I didn't need those, yet.

First step of #2476

runtimeconfig/README.rst

+-  `API Documentation`_
+
+.. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
+.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/


runtimeconfig/README.rst

+The Google Cloud `RuntimeConfig`_ (`RuntimeConfig API docs`_) API enables
+developers to dynamically configure and expose variables through Google Cloud
+Platform. In addition, you can also set Watchers and Waiters (not yet supported
+by this client library) that will watch for changes to your data and return


runtimeconfig/google/cloud/__init__.py

@@ -0,0 +1,20 @@
+# Copyright 2014 Google Inc.


runtimeconfig/google/cloud/runtimeconfig/__init__.py

+# limitations under the License.
+
+"""Google Cloud Runtime Configurator API package."""
+from google.cloud.runtimeconfig.client import Client


runtimeconfig/google/cloud/runtimeconfig/_helpers.py

+    """Extract the config name from a full resource name.
+
+      >>> _config_name_from_full_name('projects/my-proj/configs/my-config')
+      "my-config"


runtimeconfig/unit_tests/test__helpers.py

+        config_name = self._callFUT(PATH)
+        self.assertEqual(config_name, CONFIG_NAME)
+
+class Test_variable_name_from_full_name(unittest.TestCase):


runtimeconfig/unit_tests/test__helpers.py

+        CONFIG_NAME = 'CONFIG_NAME'
+        PROJECT = 'my-project-1234'
+        PATH = 'projects/%s/configs/%s/variables/%s' % (
+                PROJECT, CONFIG_NAME, VARIABLE_NAME)


runtimeconfig/unit_tests/test__helpers.py

+        CONFIG_NAME = 'CONFIG_NAME'
+        PROJECT = 'my-project-1234'
+        PATH = 'projects/%s/configs/%s/variables/%s' % (
+                PROJECT, CONFIG_NAME, VARIABLE_NAME)


runtimeconfig/google/cloud/runtimeconfig/variable.py

+
+import httplib2
+import six
+from six.moves.urllib.parse import quote


runtimeconfig/unit_tests/test_config.py

+    def test_ctor(self):
+        client = _Client(project=self.PROJECT)
+        config = self._makeOne(name=self.CONFIG_NAME,
+                              client=client)


tswast · 2016-10-03T21:49:42Z

Oops, looks like I mixed tabs and spaces and didn't reach 100% coverage on variable.py. Addressing now.

tswast · 2016-10-03T22:21:59Z

Updated, please take a second look.

tswast · 2016-10-03T22:56:03Z

I'm getting a lint error

************* Module google.cloud.runtimeconfig._helpers
C: 52, 0: Line too long (89/80) (line-too-long)

The line is

                      'projects/project-name/configs/config-name/variables/variable-name'

I don't think there's anything I can do to shrink it down.

tswast · 2016-10-04T00:55:07Z

Okay, I think I finally made the linter happy. I shrunk the problematic line down by changing the "names" project-name -> proj-name, config-name -> cfg-name

runtimeconfig/google/cloud/runtimeconfig/_helpers.py

+
+    # Variables are hierarchical. Each node in the hierarchy is separated by a
+    # / character.
+    return '/'.join(parts[5:])


runtimeconfig/google/cloud/runtimeconfig/config.py

+        :rtype: string
+        :returns: The full name based on project and config names.
+
+        :raises: :class:`ValueError` if the config is missing a name.


runtimeconfig/google/cloud/runtimeconfig/variable.py

+                  ``None`` if the property is not set locally.
+        """
+        value = self._properties.get('updateTime')
+        if value:


dhermes · 2016-10-04T04:48:08Z

@tswast RE: a line with a string that's too long (like 'projects/project-name/configs/config-name/variables/variable-name')

You can use an implicit strong concat in Python:

my_var = ('the beginning of the string '
          'and here is some more of it')

RE: Mixing tabs and spaces, please get rid of all tabs. You can check for them via git grep -l $'\t'. If any files have tabs other than

Makefile.bigtable_v2
Makefile.datastore
docs/Makefile
docs/_static/images/favicon.ico
docs/_static/images/gcp-logo-32x32.png
docs/_static/images/gcp-logo.png
system_tests/data/CloudPlatform_128px_Retina.png
system_tests/data/five-point-one-mb-file.zip
system_tests/key.json.enc

then you should find the offending lines via git grep -n $'\t' and get rid of the tabs

runtimeconfig/google/cloud/runtimeconfig/variable.py

+        except NotFound:
+            return False
+
+    def reload(self, client=None, fields=None):


runtimeconfig/unit_tests/test_config.py

+    def test_ctor_w_no_name(self):
+        client = _Client(project=self.PROJECT)
+        config = self._makeOne(name=None, client=client)
+        self.assertRaises(ValueError, lambda: config.full_name)


runtimeconfig/unit_tests/test_variable.py

+        client = _Client(project=self.PROJECT)
+        config = Config(name=self.CONFIG_NAME, client=client)
+        variable = self._makeOne(name=None, config=config)
+        self.assertRaises(ValueError, lambda: variable.full_name)


runtimeconfig/unit_tests/test_config.py

+        self.assertEqual(len(conn._requested), 1)
+        req = conn._requested[0]
+        self.assertEqual(req['method'], 'GET')
+        self.assertEqual(req['path'], '/%s' % self.CONFIG_PATH)


tswast · 2016-10-05T18:11:04Z

Ping. Please take a second look. I believe I have addressed all open comments.

tswast · 2016-10-13T16:50:59Z

@dhermes @jonparrott Please review. Is this ready to merge? I just rebased against the latest master.

theacodes

@tswast there doesn't seem to be any way to create configs or variables, is this intentional because this is just the first step?

runtimeconfig/README.rst

+See the ``google-cloud-python`` API `RuntimeConfig documentation`_ to learn
+how to analyze images using this library.
+
+.. _Vision documentation: https://google-cloud-python.readthedocs.io/en/stable/runtimeconfig-usage.html


runtimeconfig/google/cloud/runtimeconfig/client.py

+          This will not make an HTTP request; it simply instantiates
+          a config object owned by this client.
+
+        :type config_name: string


runtimeconfig/google/cloud/runtimeconfig/config.py

+        self._properties = {}
+
+    def __repr__(self):
+        return '<Config: %s>' % (self.name,)


runtimeconfig/google/cloud/runtimeconfig/config.py

+        :rtype: string
+        :returns: The URL path based on project and config names.
+        """
+        return '/%s' % (self.full_name,)


runtimeconfig/google/cloud/runtimeconfig/config.py

+          This will not make an HTTP request; it simply instantiates
+          a variable object owned by this config.
+
+        :type variable_name: string


runtimeconfig/google/cloud/runtimeconfig/variable.py

+        """
+        if not self.name:
+            raise ValueError('Missing variable name.')
+        return '%s/variables/%s' % (self.config.full_name, self.name)


runtimeconfig/google/cloud/runtimeconfig/variable.py

+        :rtype: string
+        :returns: The URL path based on config and variable names.
+        """
+        return '/%s' % (self.full_name,)


runtimeconfig/google/cloud/runtimeconfig/variable.py

+    def path(self):
+        """URL path for the variable's APIs.
+
+        :rtype: string


runtimeconfig/google/cloud/runtimeconfig/variable.py

+        https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/v1beta1/projects.configs.variables#VariableState
+
+        :rtype: string or ``NoneType``
+        :returns: If set, one of "UPDATED", "DELETED", or


runtimeconfig/google/cloud/runtimeconfig/_helpers.py

+      "my-config"
+
+    :type full_name: string
+    :param full_name: the full resource name of a config. The full resource


Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: googleapis#2485 (comment) `str` is a type, `string` is a module.

To keep the initial review small, this includes only a minimal set of features. It supports listing and getting variables, but not the other methods of the API.

tswast · 2016-10-24T16:36:02Z

@jonparrott @dhermes Please take another look. I believe I have addressed all your comments.

@tswast there doesn't seem to be any way to create configs or variables, is this intentional because this is just the first step?

Yes. I wanted to keep the initial PR as small as possible to start. Plus, dpebot and the other samples I want to create will just need read access, not write access to RuntimeConfig. After this goes in, we can add creates in, if only so that we can create system tests for this. Right now I'm running the following snippets manually to verify that it does what I want:

$ gcloud config configurations activate kittenbot
export GOOGLE_CLOUD_PROJECT=my-project-name
$ python

from google.cloud import runtimeconfig
client = runtimeconfig.Client()
config = client.config('kittenbot')
iterator = config.list_variables()
iterator.update_page()
variables = list(iterator.page)
print(variables)
token = iterator.next_page_token
print(token)

v = config.get_variable('slack-token')
print(v)

Broken by simultaneous merges of googleapis#2594 and googleapis#2485.

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: googleapis#2485 (comment) `str` is a type, `string` is a module.

Add support for RuntimeConfig API.

Broken by simultaneous merges of googleapis#2594 and googleapis#2485.

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: googleapis/google-cloud-python#2485 (comment) `str` is a type, `string` is a module.

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

Broken by simultaneous merges of #2594 and #2485.

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 3, 2016

tswast mentioned this pull request Oct 3, 2016

Add support for RuntimeConfig API googleapis/google-cloud-java#1305

Closed

dhermes suggested changes Oct 3, 2016

View reviewed changes

tswast force-pushed the master branch from 6233948 to 69e1086 Compare October 4, 2016 00:49

dhermes reviewed Oct 4, 2016

View reviewed changes

runtimeconfig/google/cloud/runtimeconfig/_helpers.py Outdated

# Variables are hierarchical. Each node in the hierarchy is separated by a

# / character.

return '/'.join(parts[5:])

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes reviewed Oct 4, 2016

View reviewed changes

runtimeconfig/google/cloud/runtimeconfig/config.py

:rtype: string

:returns: The full name based on project and config names.

:raises: :class:`ValueError` if the config is missing a name.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes reviewed Oct 4, 2016

View reviewed changes

runtimeconfig/google/cloud/runtimeconfig/variable.py Outdated

``None`` if the property is not set locally.

"""

value = self._properties.get('updateTime')

if value:

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes reviewed Oct 4, 2016

View reviewed changes

tswast force-pushed the master branch from 40155ca to 602013d Compare October 4, 2016 16:56

tswast force-pushed the master branch from 3e7772e to eed993b Compare October 6, 2016 22:33

tswast assigned theacodes and dhermes Oct 6, 2016

tswast force-pushed the master branch from eed993b to 1f64cf5 Compare October 13, 2016 16:50

theacodes suggested changes Oct 13, 2016

View reviewed changes

This was referenced Oct 20, 2016

Replace types string with str. #2579

Merged

Replaces integer with int in types and rtypes. #2580

Merged

tswast force-pushed the master branch 2 times, most recently from fa518e1 to da5092b Compare October 24, 2016 16:11

Add initial support for RuntimeConfig API.

119a43c

To keep the initial review small, this includes only a minimal set of features. It supports listing and getting variables, but not the other methods of the API.

tswast force-pushed the master branch from da5092b to 119a43c Compare October 24, 2016 16:30

theacodes approved these changes Oct 25, 2016

View reviewed changes

dhermes approved these changes Oct 25, 2016

View reviewed changes

tswast merged commit a23ca8e into googleapis:master Oct 25, 2016

dhermes added a commit to dhermes/google-cloud-python that referenced this pull request Oct 25, 2016

Fixing b0rken runtimeconfig unit tests.

7f5ac7a

Broken by simultaneous merges of googleapis#2594 and googleapis#2485.

dhermes mentioned this pull request Oct 25, 2016

Fixing b0rken runtimeconfig unit tests. #2612

Merged

dhermes mentioned this pull request Nov 14, 2016

Upgrading core to version to 0.21.0. #2733

Merged

dhermes mentioned this pull request Dec 9, 2016

Update versions for mega-release. #2846

Merged

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017

Merge pull request googleapis#2485 from tswast/master

0258fb7

Add support for RuntimeConfig API.

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017

Fixing b0rken runtimeconfig unit tests.

e43dd61

Broken by simultaneous merges of googleapis#2594 and googleapis#2485.

theacodes unassigned dhermes Sep 28, 2018

parthea pushed a commit that referenced this pull request Oct 21, 2023

Replace string with str in rtypes.

a6f94a7

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

parthea pushed a commit that referenced this pull request Nov 24, 2025

Fixing b0rken runtimeconfig unit tests.

442751d

Broken by simultaneous merges of #2594 and #2485.

parthea pushed a commit that referenced this pull request Nov 24, 2025

Replace string with str in rtypes.

8313472

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

parthea pushed a commit that referenced this pull request Nov 24, 2025

Replace string with str in rtypes.

fa50f63

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

parthea pushed a commit that referenced this pull request Nov 24, 2025

Replace string with str in rtypes.

c2bcd4e

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

parthea pushed a commit that referenced this pull request Mar 2, 2026

Replace string with str in rtypes.

53d4cff

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

parthea pushed a commit that referenced this pull request Mar 9, 2026

Replace string with str in rtypes.

52c7ffd

Used the command: ag -l 'rtype: string' | xargs sed -i .bak 's/rtype: string/rtype: str/g' Based on this comment: #2485 (comment) `str` is a type, `string` is a module.

Conversation

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.