Fixes gRPC device registration in Python 2.7

The built-in path mkdir function recently added a parameter that we are using. This change adds a backport of this feature where applicable.

Another test was added to verify this change works.

Bug: 72382392
Change-Id: I2d3016fc018e6ebd423ee4bdbe099e2135e0f698

Author: Fleker

google-assistant-sdk/googlesamples/assistant/grpc/devicetool.py

@@ -24,6 +24,7 @@
 
 
 ASSISTANT_API_VERSION = 'v1alpha2'
+logging.basicConfig(format='', level=logging.INFO)
 
 
 def failed_request_exception(message, r):
@@ -80,8 +81,8 @@ def build_client_from_context(ctx):
 
 def pretty_print_model(devicemodel):
     """Prints out a device model in the terminal by parsing dict."""
-    PRETTY_PRINT_MODEL = """Device Model Id: %(deviceModelId)s
-        Project Id: %(projectId)s
+    PRETTY_PRINT_MODEL = """Device Model ID: %(deviceModelId)s
+        Project ID: %(projectId)s
         Device Type: %(deviceType)s"""
     logging.info(PRETTY_PRINT_MODEL % devicemodel)
     if 'traits' in devicemodel:
@@ -94,7 +95,7 @@ def pretty_print_model(devicemodel):
 
 def pretty_print_device(device):
     """Prints out a device instance in the terminal by parsing dict."""
-    logging.info('Device Instance Id: %s' % device['id'])
+    logging.info('Device Instance ID: %s' % device['id'])
     if 'nickname' in device:
         logging.info('    Nickname: %s' % device['nickname'])
     if 'modelId' in device:
@@ -152,8 +153,8 @@ def cli(ctx, project_id, client_secrets, verbose, api_endpoint, credentials):
     ctx.obj['PROJECT_ID'] = project_id
     ctx.obj['CREDENTIALS'] = c
     ctx.obj['CLIENT_SECRETS'] = client_secrets
-    logging.basicConfig(format='',
-                        level=logging.DEBUG if verbose else logging.INFO)
+    if verbose:
+        logging.getLogger().setLevel(logging.DEBUG)
 
 
 @cli.command()

google-assistant-sdk/googlesamples/assistant/grpc/pushtotalk.py

@@ -19,6 +19,7 @@
 import logging
 import os
 import os.path
+import pathlib2 as pathlib
 import sys
 import uuid
 
@@ -399,7 +400,7 @@ def onoff(on):
                 logging.error('Failed to register device: %s', r.text)
                 sys.exit(-1)
             logging.info('Device registered: %s', device_id)
-            os.makedirs(os.path.dirname(device_config), exist_ok=True)
+            pathlib.Path(os.path.dirname(device_config)).mkdir(exist_ok=True)
             with open(device_config, 'w') as f:
                 json.dump(payload, f)
 

google-assistant-sdk/googlesamples/assistant/grpc/requirements.txt

@@ -5,4 +5,4 @@ sounddevice>=0.3.7,<0.4
 click>=6.7,<7
 tenacity>=4.1.0,<5
 futures>=3.1.1,<4
-
+pathlib2==2.3.0

google-assistant-sdk/tests/test_endtoend.py

@@ -13,12 +13,50 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 import tempfile
+import os
 import os.path
+import pytest
 import subprocess
+import uuid
 
 
 import builtins
+PROJECT_ID = os.environ.get('PROJECT_ID', 'dummy-project-id')
+
+
+@pytest.fixture(scope='session')
+def device_model():
+    device_model_id = 'assistant-sdk-test-model-%s' % str(uuid.uuid1())
+    subprocess.check_call(['python', '-m',
+                           'googlesamples.assistant.grpc.devicetool',
+                           '--project-id', PROJECT_ID,
+                           'register-model', '--model', device_model_id,
+                           '--type', 'LIGHT',
+                           '--manufacturer', 'assistant-sdk-test',
+                           '--product-name', 'assistant-sdk-test'])
+    yield device_model_id
+    subprocess.check_call(['python', '-m',
+                           'googlesamples.assistant.grpc.devicetool',
+                           '--project-id', PROJECT_ID,
+                           'delete', '--model', device_model_id])
+
+
+@pytest.fixture(scope='session')
+def device_instance(device_model):
+    device_instance_id = 'assistant-sdk-test-device-%s' % str(uuid.uuid1())
+    subprocess.check_call(['python', '-m',
+                           'googlesamples.assistant.grpc.devicetool',
+                           '--project-id', PROJECT_ID,
+                           'register-device', '--model', device_model,
+                           '--client-type', 'SERVICE',
+                           '--device', device_instance_id])
+    yield device_instance_id
+    subprocess.check_call(['python', '-m',
+                           'googlesamples.assistant.grpc.devicetool',
+                           '--project-id', PROJECT_ID,
+                           'delete', '--device', device_instance_id])
 
 
 def test_endtoend_pushtotalk():
@@ -36,12 +74,48 @@ def test_endtoend_pushtotalk():
     assert os.path.getsize(audio_out_file) > 0
 
 
-def test_endtoend_textinput():
+def test_registration_pushtotalk(device_model):
+    temp_dir = tempfile.mkdtemp()
+    audio_out_file = os.path.join(temp_dir, 'out.raw')
+    # Use an non-existing device config file intentionally
+    # to force device registration.
+    device_config = os.path.join(temp_dir, 'device_config.json')
+    out = subprocess.check_output(['python', '-m',
+                                   'googlesamples.assistant.grpc.pushtotalk',
+                                   '--verbose',
+                                   '--project-id', PROJECT_ID,
+                                   '--device-model-id', device_model,
+                                   '--device-config', device_config,
+                                   '-i', 'tests/data/whattimeisit.riff',
+                                   '-o', audio_out_file],
+                                  stderr=subprocess.STDOUT)
+    assert 'what time is it' in builtins.str(out).lower()
+    assert os.path.getsize(audio_out_file) > 0
+    with open(device_config) as f:
+        config = json.load(f)
+        assert ('device registered: %s' % config['id']
+                in builtins.str(out).lower())
+        out = subprocess.check_output(
+            ['python', '-m',
+             'googlesamples.assistant.grpc.devicetool',
+             '--project-id', PROJECT_ID,
+             'get', '--device', config['id']],
+            stderr=subprocess.STDOUT
+        )
+        assert ('device instance id: %s' % config['id']
+                in builtins.str(out).lower())
+        subprocess.check_call(['python', '-m',
+                               'googlesamples.assistant.grpc.devicetool',
+                               '--project-id', PROJECT_ID,
+                               'delete', '--device', config['id']])
+
+
+def test_endtoend_textinput(device_model, device_instance):
     p = subprocess.Popen(['python', '-m',
                           'googlesamples.assistant.grpc.textinput',
                           '--verbose',
-                          '--device-model-id', 'test-device-model',
-                          '--device-id', 'test-device'],
+                          '--device-model-id', device_model,
+                          '--device-id', device_instance],
                          stdin=subprocess.PIPE,
                          stdout=subprocess.PIPE)
     out, err = p.communicate(b'how do you say grapefruit in French?')