robotframework-qconnect-base 1.1.3__tar.gz

robotframework-qconnect-base-1.1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

robotframework-qconnect-base-1.1.3/PKG-INFO

@@ -0,0 +1,383 @@
+Metadata-Version: 2.1
+Name: robotframework-qconnect-base
+Version: 1.1.3
+Summary: Robot Framework test library for TCP, SSH, serial connection
+Home-page: https://github.com/test-fullautomation/robotframework-qconnect-base
+Author: Nguyen Huynh Tri Cuong
+Author-email: cuong.nguyenhuynhtri@vn.bosch.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+QConnectBase Library
+====================
+
+QConnectBaseLibrary is a connection testing library for [Robot
+Framework](https://robotframework.org). Library will be supported to
+downloaded from PyPI soon. It provides a mechanism to handle trace log
+continously receiving from a connection (such as Raw TCP, SSH, Serial,
+etc.) besides sending data back to the other side. It's especially
+efficient for monitoring the overflood response trace log from an
+asynchronous trace systems. It is supporting Python 3.7+ and
+RobotFramework 3.2+.
+
+Table of Contents
+-----------------
+
+-   [Getting Started](#getting-started)
+-   [Usage](#building-and-testing)
+-   [Example](#example)
+-   [Contribution Guidelines](#contribution-guidelines)
+-   [Configure Git and correct EOL
+    handling](#configure-Git-and-correct-EOL-handling)
+-   [Sourcecode Documentation](#documentation)
+-   [Feedback](#feedback)
+-   [About](#about)
+    -   [Maintainers](#maintainers)
+    -   [Contributors](#contributors)
+    -   [3rd Party Licenses](#3rd-party-licenses)
+    -   [Used Encryption](#used-encryption)
+    -   [License](#license)
+
+Getting Started
+---------------
+
+We have a plan to publish all the sourcecode as OSS in the near future
+so that you can downloaded from PyPI. For the current period, you can
+checkout
+
+[QConnectBaseLibrary](https://github.com/test-fullautomation/robotframework-qconnect-base)
+
+After checking out the source completely, you can install by running
+below command inside **robotframework-qconnect-base** directory.
+
+    python setup.py install
+
+Usage
+-----
+
+QConnectBase Library support following keywords for testing connection
+in RobotFramework.
+
+### **connect**
+
+> **Use for establishing a connection.**
+>
+> **Syntax**:
+>
+> > **connect** `[conn_name]   [conn_type]   [conn_mode]   [conn_conf]`
+> > *(All parameters are required to be in order)* or
+> >
+> > **connect**
+> > `conn_name=[conn_name]   conn_type=[conn_type]   conn_mode=[conn_mode]   conn_conf=[conn_conf]`
+> > *(All parameters are assigned by name)*
+>
+> **Arguments**:
+>
+> > **conn\_name**: Name of the connection.
+> >
+> > **conn\_type**: Type of the connection. QConnectBaseLibrary has
+> > supported below connection types:
+> >
+> > > -   **TCPIPClient**: Create a Raw TCPIP connection to TCP Server.
+> > > -   **SSHClient**: Create a client connection to a SSH server.
+> > > -   **SerialClient**: Create a client connection via Serial Port.
+> >
+> > **conn\_mode**: (unused) Mode of a connection type.
+> >
+> > **conn\_conf**: Configurations for making a connection. Depend on
+> > **conn\_type** (Type of Connection), there is a suitable
+> > configuration in JSON format as below.
+> >
+> > > -   **TCPIPClient**
+> > >
+> > > ```{=html}
+> > > <!-- -->
+> > > ```
+> > >     {
+> > >         "address": [server host], # Optional. Default value is "localhost".
+> > >         "port": [server port]     # Optional. Default value is 1234.
+> > >         "logfile": [Log file path. Possible values: 'nonlog', 'console', <user define path>]
+> > >      }
+> > >
+> > > -   **SSHClient**
+> > >
+> > > ```{=html}
+> > > <!-- -->
+> > > ```
+> > >     {
+> > >         "address" : [server host],  # Optional. Default value is "localhost".
+> > >         "port" : [server host],     # Optional. Default value is 22.
+> > >         "username" : [username],    # Optional. Default value is "root".
+> > >         "password" : [password],    # Optional. Default value is "".
+> > >         "authentication" : "password" | "keyfile" | "passwordkeyfile",  # Optional. Default value is "".
+> > >         "key_filename" : [filename or list of filenames], # Optional. Default value is null.
+> > >         "logfile": [Log file path. Possible values: 'nonlog', 'console', <user define path>]
+> > >      }
+> > >
+> > > -   **SerialClient**
+> > >
+> > > ```{=html}
+> > > <!-- -->
+> > > ```
+> > >     {
+> > >         "port" : [comport or null],
+> > >         "baudrate" : [Baud rate such as 9600 or 115200 etc.],
+> > >         "bytesize" : [Number of data bits. Possible values: 5, 6, 7, 8],
+> > >         "stopbits" : [Number of stop bits. Possible values: 1, 1.5, 2],
+> > >         "parity" : [Enable parity checking. Possible values: 'N', 'E', 'O', 'M', 'S'],
+> > >         "rtscts" : [Enable hardware (RTS/CTS) flow control.],
+> > >         "xonxoff" : [Enable software flow control.],
+> > >         "logfile": [Log file path. Possible values: 'nonlog', 'console', <user define path>]
+> > >      }
+
+### **disconnect**
+
+> **Use for disconnect a connection by name.**
+>
+> **Syntax**:
+>
+> > **disconnect** `conn_name`
+>
+> **Arguments**:
+>
+> > **conn\_name**: Name of the connection.
+
+### **send command**
+
+> **Use for sending a command to the other side of connection.**
+>
+> **Syntax**:
+>
+> > **send command** `[conn_name]   [command]` *(All parameters are
+> > required to be in order)* or
+> >
+> > **send command** `conn_name=[conn_name]   command=[command]` *(All
+> > parameters are assigned by name)* \#\#\#\#\# *Arguments*:
+
+-   **conn\_name**: Name of the connection.
+-   **command**: Command to be sent.
+
+### **verify**
+
+> **Use for verifying a response from the connection if it matched a
+> pattern.**
+>
+> **Syntax**:
+>
+> > **verify**
+> > `[conn_name]   [search_pattern]   [timeout]   [fetch_block]  [eob_pattern] [filter_pattern]  [send_cmd]`*(All
+> > parameters are required to be in order)* or
+> >
+> > **verify**
+> > `conn_name=[conn_name]   search_pattern=[search_pattern]  timeout=[timeout]  fetch_block=[fetch_block]  eob_pattern=[eob_pattern] filter_pattern=[filter_pattern]  send_cmd=[send_cmd]`
+> > *(All parameters are assigned by name)*
+>
+> **Arguments**:
+>
+> > **conn\_name**: Name of the connection.
+> >
+> > **search\_pattern**: Regular expression for matching with the
+> > response.
+> >
+> > **timeout**: Timeout for waiting response matching pattern.
+> >
+> > **fetch\_block**: If this value is true, every response line will be
+> > put into a block untill a line match **eob\_pattern** pattern.
+> >
+> > **eob\_pattern**: Regular expression for matching the endline when
+> > using **fetch\_block**.
+> >
+> > **filter\_pattern**: Regular expression for filtering every line of
+> > block when using **fetch\_block**.
+> >
+> > **send\_cmd**: Command to be sent to the other side of connection
+> > and waiting for response.
+>
+> **Return value**:
+>
+> > **A corresponding match object if it is found.**
+> >
+> > **E.g.**
+> >
+> >     ${result} = verify  conn_name=SSH_Connection
+> >                          search_pattern=(?<=\s).*([0-9]..).*(command).$
+> >                          send_cmd=*echo This is the 1st test command.*
+> >
+> > -   \${result}\[0\] will be **\"This is the 1st test command.\"**
+> >     which is the matched string.
+> > -   \${result}\[1\] will be **\"1st\"** which is the first captured
+> >     string.
+> > -   \${result}\[2\] will be **\"command\"** which is the second
+> >     captured string.
+
+Example
+-------
+
+    *** Settings ***
+    Documentation    Suite description
+    Library     QConnectionLibrary.ConnectionManager
+
+    *** Test Cases ***
+    Test SSH Connection
+        # Create config for connection.
+        ${config_string}=    catenate
+        ...  {
+        ...   "address": "127.0.0.1",
+        ...   "port": 8022,
+        ...   "username": "root",
+        ...   "password": "",
+        ...   "authentication": "password",
+        ...   "key_filename": null
+        ...  }
+        log to console       \nConnecting with configurations:\n${config_string}
+        ${config}=             evaluate        json.loads('''${config_string}''')    json
+
+        # Connect to the target with above configurations.
+        connect             conn_name=test_ssh
+        ...                 conn_type=SSHClient
+        ...                 conn_conf=${config}
+
+        # Send command 'cd ..' and 'ls' then wait for the response '.*' pattern.
+        send command                conn_name=test_ssh
+        ...                         command=cd ..
+
+        ${res}=     verify                  conn_name=test_ssh
+        ...                                 search_pattern=.*
+        ...                                 send_cmd=ls
+        log to console     ${res}
+
+        # Disconnect
+        disconnect  test_ssh
+
+Contribution Guidelines
+-----------------------
+
+QConnectBaseLibrary is designed for ease of making an extension library.
+By that way you can take advantage of the QConnectBaseLibrary's
+infrastructure for handling your own connection protocal. For creating
+an extension library for QConnectBaseLibrary, please following below
+steps.
+
+1.  Create a library package which have the prefix name is
+    **robotframework-qconnect-***\[your specific name\]*.
+2.  Your hadling connection class should be derived from
+    **QConnectionLibrary.connection\_base.ConnectionBase** class.
+3.  In your *Connection Class*, override below attributes and methods:
+
+> -   **\_CONNECTION\_TYPE**: name of your connection type. It will be
+>     the input of the conn\_type argument when using **connect**
+>     keyword. Depend on the type name, the library will detemine the
+>     correct connection handling class.
+> -   **\_\_init\_\_(self, \_mode, config)**: in this constructor
+>     method, you should:
+>
+> > -   Prepare resource for your connection.
+> >
+> > -   Initialize receiver thread by calling
+> >     **self.\_init\_thread\_receiver(cls.\_socket\_instance,
+> >     mode=\"\")** method.
+> >
+> > -   Configure and initialize the lowlevel receiver thread (if it's
+> >     necessary) as below
+> >
+> >         self._llrecv_thrd_obj = None
+> >          self._llrecv_thrd_term = threading.Event()
+> >          self._init_thrd_llrecv(cls._socket_instance)
+> >
+> > -   Incase you use the lowlevel receiver thread. You should
+> >     implement the **thrd\_llrecv\_from\_connection\_interface()**
+> >     method. This method is a mediate layer which will receive the
+> >     data from connection at the very beginning, do some process then
+> >     put them in a queue for the **receiver thread** above getting
+> >     later.
+> >
+> > -   Create the queue for this connection (use Queue.Queue).
+>
+> -   **connect()**: implement the way you use to make your own
+>     connection protocol.
+> -   **\_read()**: implement the way to receive data from connection.
+> -   **\_write()**: implement the way to send data via connection.
+> -   **disconnect()**: implement the way you use to disconnect your own
+>     connection protocol.
+> -   **quit()**: implement the way you use to quit connection and clean
+>     resource.
+
+Configure Git and correct EOL handling
+--------------------------------------
+
+Here you can find the references for [Dealing with line
+endings](https://help.github.com/articles/dealing-with-line-endings/).
+
+Every time you press return on your keyboard you're actually inserting
+an invisible character called a line ending. Historically, different
+operating systems have handled line endings differently. When you view
+changes in a file, Git handles line endings in its own way. Since you're
+collaborating on projects with Git and GitHub, Git might produce
+unexpected results if, for example, you're working on a Windows machine,
+and your collaborator has made a change in OS X.
+
+To avoid problems in your diffs, you can configure Git to properly
+handle line endings. If you are storing the .gitattributes file directly
+inside of your repository, than you can asure that all EOL are manged by
+git correctly as defined.
+
+Sourcecode Documentation
+------------------------
+
+For investigating sourcecode, please refer to [QConnectBase library
+documentation](docs/html/index.html)
+
+A detailed documentation of the QConnectBase package can also be found
+here:
+[QConnectBase.pdf](https://github.com/test-fullautomation/robotframework-qconnect-base/blob/develop/QConnectBase/QConnectBase.pdf)
+
+Feedback
+--------
+
+If you have any problem when using the library or think there is a
+better solution for any part of the library, I'd love to know it, as
+this will all help me to improve the library. Please don\'t hesitate to
+contact me.
+
+Do share your valuable opinion, I appreciate your honest feedback!
+
+About
+-----
+
+### Maintainers
+
+[Nguyen Huynh Tri Cuong](mailto:Cuong.NguyenHuynhTri@vn.bosch.com)
+
+### Contributors
+
+[Nguyen Huynh Tri Cuong](mailto:Cuong.NguyenHuynhTri@vn.bosch.com)
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+License
+-------
+
+Copyright 2020-2022 Robert Bosch GmbH
+
+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.
+
+

robotframework-qconnect-base-1.1.3/QConnectBase/__init__.py

@@ -0,0 +1,22 @@
+#  Copyright 2020-2022 Robert Bosch GmbH
+#
+#  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.
+from QConnectBase.connection_manager import ConnectionManager
+
+
+class ConnectionManager(ConnectionManager):
+   """
+Class to manage all connections.
+   """
+   ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+