Release UI Automator 0.0.0
PiperOrigin-RevId: 570263743
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
index 624e8bc..894e9eb 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,8 @@
### Installation
1. clone this repo.
-1. `cd` to the folder.
+2. `cd` to the folder.
+3. Run `pip install .`
## Usage
@@ -41,3 +42,9 @@
- [x] Commissioning Matter device
## Notice
+
+## Report issue
+
+- Click
+ [here](https://issuetracker.google.com/issues/new?component=655104&template=1694023)
+ to report any encountered issues.
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..3cf63bf
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+mobly==1.12
+inflection
+absl-py
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..979eaa0
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,75 @@
+"""Build the google_home_ui_automator Python package."""
+import os
+
+import setuptools
+
+from ui_automator import version
+
+_CURRENT_DIR = os.path.abspath(os.path.dirname(__file__))
+_README_FILE = 'README.md'
+_REQUIREMENTS_FILE = 'requirements.txt'
+_SOURCE_CODE_DIR_NAME = 'ui_automator'
+
+
+def _get_readme() -> str:
+ """Returns contents of README.md."""
+ readme_file = os.path.join(_CURRENT_DIR, _README_FILE)
+ with open(readme_file) as open_file:
+ return open_file.read()
+
+
+def _get_requirements() -> list[str]:
+ """Returns package requirements from requirements.txt."""
+ requirements_file = os.path.join(_CURRENT_DIR, _REQUIREMENTS_FILE)
+ with open(requirements_file) as open_file:
+ requirements = open_file.read()
+ if requirements:
+ return requirements.splitlines()
+ raise RuntimeError(
+ 'Unable to find package requirements in {}'.format(requirements_file)
+ )
+
+
+def _get_version() -> str:
+ """Returns version from version.py."""
+ return version.VERSION
+
+
+setuptools.setup(
+ name='google-home-ui-automator',
+ version=_get_version(),
+ description='Google Home UI Automator',
+ long_description=_get_readme(),
+ long_description_content_type='text/markdown',
+ python_requires='>=3.7',
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: Apache Software License',
+ 'Operating System :: MacOS',
+ 'Operating System :: POSIX :: Linux',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: 3.8',
+ 'Programming Language :: Python :: 3.9',
+ 'Programming Language :: Python :: 3.10',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ 'Topic :: Software Development :: Testing',
+ ],
+ # project's homepage
+ url='https://github.com/google/home-ui-automator',
+ # author details
+ author='Google LLC',
+ author_email='google-home-testsuite-dev+ui-automator@google.com',
+ license='Apache 2.0',
+ # define list of packages included in distribution
+ packages=setuptools.find_packages(exclude=['ui_automator.tests*']),
+ package_dir={'ui_automator': _SOURCE_CODE_DIR_NAME},
+ package_data={
+ 'ui_automator': [],
+ },
+ # runtime dependencies that are installed by pip during install
+ install_requires=_get_requirements(),
+ entry_points={
+ 'console_scripts': ['ui-automator = ui_automator.ui_automator:run'],
+ },
+)
diff --git a/ui_automator/CHANGELOG.md b/ui_automator/CHANGELOG.md
new file mode 100644
index 0000000..22d0020
--- /dev/null
+++ b/ui_automator/CHANGELOG.md
@@ -0,0 +1,2 @@
+0.0.0: Initial release
+- Support for commissioning Matter devices on Google Home App
diff --git a/ui_automator/android/app/snippet-0.0.0.apk b/ui_automator/android/app/snippet-0.0.0.apk
new file mode 100644
index 0000000..5f5d253
--- /dev/null
+++ b/ui_automator/android/app/snippet-0.0.0.apk
Binary files differ
diff --git a/ui_automator/ui_automator.py b/ui_automator/ui_automator.py
index 8f032e5..6fe4335 100644
--- a/ui_automator/ui_automator.py
+++ b/ui_automator/ui_automator.py
@@ -285,11 +285,15 @@
ui_automator.commission_device(*_COMMISSION.value)
-def main(argv: Sequence[str]) -> None:
+def _main(argv: Sequence[str]) -> None:
del argv
ui_automator = UIAutomator()
_commission(ui_automator)
+def run():
+ app.run(_main)
+
+
if __name__ == '__main__':
- app.run(main)
+ run()
diff --git a/ui_automator/ui_automator_test.py b/ui_automator/ui_automator_test.py
index 829b7d3..b8224e5 100644
--- a/ui_automator/ui_automator_test.py
+++ b/ui_automator/ui_automator_test.py
@@ -2,12 +2,9 @@
import os
import subprocess
import sys
-import traceback
import unittest
from unittest import mock
-from absl import app
-from absl.testing import flagsaver
from mobly.controllers import android_device
from mobly.controllers.android_device_lib import adb
from mobly.snippet import errors as snippet_errors
@@ -370,38 +367,18 @@
gha_room=invalid_gha_room,
)
- @flagsaver.flagsaver(
- (ui_automator._COMMISSION, ['m5stack', '34970112332', 'Office'])
- )
+ @mock.patch.object(sys, 'exit')
@mock.patch.object(ui_automator.UIAutomator, 'commission_device')
- def test_main_calls_commission_device_with_valid_arguments(
- self, mock_commission_device
+ def test_run_calls_commission_device_with_valid_arguments(
+ self, mock_commission_device, mock_exit
):
- ui_automator.main(_FAKE_VALID_SYS_ARGV)
+ with mock.patch.object(sys, 'argv', _FAKE_VALID_SYS_ARGV):
+ ui_automator.run()
mock_commission_device.assert_called_once_with(
'm5stack', '34970112332', 'Office'
)
-
- @flagsaver.flagsaver(
- (ui_automator._COMMISSION, ['m5stack', '3497', 'Office'])
- )
- @mock.patch.object(android_device, 'get_all_instances')
- def test_main_should_print_a_hint_when_cmd_args_have_invalid_value(
- self,
- mock_get_all_instances,
- ):
- mock_get_all_instances.return_value = [self.mock_android_device]
-
- with self.assertRaises(ValueError) as e:
- ui_automator.main(_FAKE_SYS_ARGV_WITH_INVALID_PAIRING_CODE)
-
- self.assertIn(
- 'Value of PairingCode is invalid. Paring code should be 11-digit or'
- ' 21-digit numeric code.',
- str(traceback.format_exception(e.exception)),
- )
- self.mock_android_device.mbs.commissionDevice.assert_not_called()
+ mock_exit.assert_called()
@mock.patch.object(sys.stderr, 'write')
@mock.patch.object(sys, 'exit')
@@ -409,7 +386,7 @@
self, mock_exit, mock_stderr_write
):
with mock.patch.object(sys, 'argv', _FAKE_SYS_ARGV_WITH_INVALID_LENGTH):
- app.run(ui_automator.main)
+ ui_automator.run()
self.assertEqual(mock_stderr_write.call_count, 2)
first_call_args = ''.join(mock_stderr_write.call_args_list[0][0])
diff --git a/ui_automator/version.py b/ui_automator/version.py
new file mode 100644
index 0000000..1f0068e
--- /dev/null
+++ b/ui_automator/version.py
@@ -0,0 +1,8 @@
+"""Get semantic version."""
+import time
+from typing import Optional
+
+
+_SEMANTIC_VERSION = "0.0.0"
+
+VERSION = _SEMANTIC_VERSION
