Skip to content
This repository was archived by the owner on Nov 23, 2023. It is now read-only.

Commit 5d91615

Browse files
committed
feat: Project deploy setup
1 parent c585cbb commit 5d91615

File tree

10 files changed

+311
-12
lines changed

10 files changed

+311
-12
lines changed

AppiumFlutterLibrary/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ class AppiumFlutterLibrary(
99
_ApplicationManagementKeyWords,
1010
_ElementKeywords,
1111
_RunOnFailureKeyWords,
12-
_WaintingKeywords
12+
_WaintingKeywords,
13+
_LoggingKeywords
1314
):
1415
ROBOT_LIBRARY_SCOPE = 'GLOBAL'
1516
ROBOT_LIBRARY_VERSION = VERSION

AppiumFlutterLibrary/finder/elementfinder.py

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,39 @@
33
class ElementFinder():
44
def __init__(self):
55
self._element_finder = FlutterFinder()
6+
self._strategies = {
7+
'xpath': self._find_by_xpath,
8+
'key': self._find_by_key
9+
}
610

7-
def find_by_key(self, application, element_key):
11+
def find(self, application, locator):
12+
assert application is not None
13+
assert application is not None and len(locator) > 0
14+
15+
(prefix , criteria) = self._parse_locator(locator)
16+
17+
prefix= 'default' if prefix is None else prefix
18+
strategy = self._strategies.get(prefix)
19+
if strategy is None:
20+
raise ValueError("Element locator with prefix '" + prefix + "' is not supported")
21+
return strategy(application, criteria)
22+
23+
def _find_by_key(self, application, element_key):
824
finder_key = self._element_finder.by_value_key(element_key)
925
element = FlutterElement(application, finder_key)
1026

11-
return element
27+
return element
28+
29+
def _find_by_xpath(self, application, xpath):
30+
return
31+
32+
def _parse_locator(self, locator):
33+
prefix = None
34+
criteria = locator
35+
36+
if not locator.startswith('//'):
37+
locator_parts = locator.partition('=')
38+
if len(locator_parts[1]) > 0:
39+
prefix = locator_parts[0].strip().lower()
40+
criteria = locator_parts[2].strip()
41+
return (prefix, criteria)

AppiumFlutterLibrary/keywords/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
from ._element import _ElementKeywords
33
from ._runonfailure import _RunOnFailureKeyWords
44
from ._waiting import _WaintingKeywords
5+
from ._logging import _LoggingKeywords
56

67
__all__ = [
78
"_ApplicationManagementKeyWords",
89
"_ElementKeywords",
10+
"_LoggingKeywords",
911
"_RunOnFailureKeyWords",
1012
"_WaintingKeywords"
1113
]

AppiumFlutterLibrary/keywords/_element.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ def __init__(self):
1111

1212
def input_text(self, locator, text):
1313
application = self._current_application()
14-
element = self._element_finder.find_by_key(application, locator)
14+
element = self._element_finder.find(application, locator)
15+
self._info("Typing text '%s' into component '%s'" % (text, locator))
1516
element.send_keys(text)
1617

1718
def click_element(self, locator):
1819
application = self._current_application()
19-
element = self._element_finder.find_by_key(application, locator)
20+
element = self._element_finder.find(application, locator)
2021
element.click()
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import os
2+
from robot.libraries.BuiltIn import BuiltIn
3+
from robot.libraries.BuiltIn import RobotNotRunningError
4+
from robot.api import logger
5+
from .keywordgroup import KeywordGroup
6+
7+
8+
class _LoggingKeywords(KeywordGroup):
9+
LOG_LEVEL_DEBUG = ['DEBUG']
10+
LOG_LEVEL_INFO = ['DEBUG', 'INFO']
11+
LOG_LEVEL_WARN = ['DEBUG', 'INFO', 'WARN']
12+
13+
@property
14+
def _log_level(self):
15+
try:
16+
level = BuiltIn().get_variable_value("${APPIUM_LOG_LEVEL}", default='DEBUG')
17+
except RobotNotRunningError:
18+
level = 'DEBUG'
19+
return level
20+
21+
def _debug(self, message):
22+
if self._log_level in self.LOG_LEVEL_DEBUG:
23+
logger.debug(message)
24+
25+
def _info(self, message):
26+
if self._log_level in self.LOG_LEVEL_INFO:
27+
logger.info(message)
28+
29+
def _warn(self, message):
30+
if self._log_level in self.LOG_LEVEL_WARN:
31+
logger.warn(message)
32+
33+
def _html(self, message):
34+
logger.info(message, True, False)
35+
36+
def _get_log_dir(self):
37+
variables = BuiltIn().get_variables()
38+
logfile = variables['${LOG FILE}']
39+
if logfile != 'NONE':
40+
return os.path.dirname(logfile)
41+
return variables['${OUTPUTDIR}']
42+
43+
def _log(self, message, level='INFO'):
44+
level = level.upper()
45+
if (level == 'INFO'):
46+
self._info(message)
47+
elif (level == 'DEBUG'):
48+
self._debug(message)
49+
elif (level == 'WARN'):
50+
self._warn(message)
51+
elif (level == 'HTML'):
52+
self._html(message)
53+
54+
def _log_list(self, items, what='item'):
55+
msg = ['Altogether %d %s%s.' % (len(items), what, ['s', ''][len(items) == 1])]
56+
for index, item in enumerate(items):
57+
msg.append('%d: %s' % (index+1, item))
58+
self._info('\n'.join(msg))
59+
return items
60+

AppiumFlutterLibrary/keywords/_screen.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ def __init__(self):
88

99
def scroll_to_element(self, locator):
1010
application = self._current_application()
11-
element = self._element_finder.find_by_key(application, locator)
11+
element = self._element_finder.find(application, locator)
1212
application.execute_script('flutter:scrollIntoView', element)

AppiumFlutterLibrary/keywords/_waiting.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def __init__(self):
99

1010
def wait_for_element(self, locator, timeout=None, error=None):
1111
application = self._current_application()
12-
element = self._element_finder.find_by_key(application, locator)
12+
element = self._element_finder.find(application, locator)
1313
application.execute_script('flutter:waitFor', element)
1414

1515
def _format_timeout(self, timeout):

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[build-system]
2+
requires = [
3+
"setuptools>=42",
4+
"wheel"
5+
]
6+
build-backend = "setuptools.build_meta"

setup.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55

66
ROOT = dirname(abspath(__file__))
77

8-
version_file = join(ROOT, 'AppiumFlutterLibrary', 'version.py')
9-
exec (compile(open(version_file).read(), version_file, 'exec'))
108

119
setup(name='robotframework-appiumflutterlibrary',
12-
version=VERSION,
10+
version='1.0.0-alpha',
1311
description='Robot Framework Mobile flutter app testing library for Appium Client Android & iOS & Web',
1412
long_description=open(join(ROOT, 'README.md')).read(),
1513
author='Igor Augusto',
@@ -19,13 +17,13 @@
1917
keywords='robotframework flutter testing testautomation mobile appium webdriver app android ios',
2018
platforms='any',
2119
classifiers=[
22-
"Development Status :: 5 - Production/Stable",
20+
"Development Status :: 1 - Planning",
21+
"Framework :: Robot Framework :: Library",
2322
"License :: OSI Approved :: Apache Software License",
2423
"Operating System :: OS Independent",
2524
"Programming Language :: Python",
2625
'Topic :: Software Development :: Quality Assurance',
2726
"Topic :: Software Development :: Testing",
28-
'Programming Language :: Python',
2927
'Programming Language :: Python :: 3.7',
3028
'Programming Language :: Python :: 3.8',
3129
],

0 commit comments

Comments
 (0)