robotframework-pabot 5.1.0__py3-none-any.whl → 5.2.0b1__py3-none-any.whl

pabot/robotremoteserver.py

@@ -452,20 +452,28 @@ class StandardStreamInterceptor(object):
         self.output = ""
         self.origout = sys.stdout
         self.origerr = sys.stderr
-        sys.stdout = StringIO()
-        sys.stderr = StringIO()
+        self.stdout_capture = StringIO()
+        self.stderr_capture = StringIO()
+        sys.stdout = self.stdout_capture
+        sys.stderr = self.stderr_capture
 
     def __enter__(self):
         return self
 
     def __exit__(self, *exc_info):
-        stdout = sys.stdout.getvalue()
-        stderr = sys.stderr.getvalue()
-        close = [sys.stdout, sys.stderr]
+        # Safely get output from captured streams, handling case where streams were restored
+        stdout = self._safe_getvalue(sys.stdout, self.stdout_capture)
+        stderr = self._safe_getvalue(sys.stderr, self.stderr_capture)
+        
+        # Close only our StringIO objects
+        for stream in [self.stdout_capture, self.stderr_capture]:
+            if hasattr(stream, 'close'):
+                stream.close()
+        
+        # Restore original streams
         sys.stdout = self.origout
         sys.stderr = self.origerr
-        for stream in close:
-            stream.close()
+
         if stdout and stderr:
             if not stderr.startswith(
                 ("*TRACE*", "*DEBUG*", "*INFO*", "*HTML*", "*WARN*", "*ERROR*")
@@ -474,6 +482,18 @@ class StandardStreamInterceptor(object):
             if not stdout.endswith("\n"):
                 stdout += "\n"
         self.output = stdout + stderr
+    
+    def _safe_getvalue(self, current_stream, original_capture):
+        """Safely get value from stream, handling case where stream was restored."""
+        # If current stream is still our StringIO, get value from it
+        if hasattr(current_stream, 'getvalue') and current_stream is original_capture:
+            return current_stream.getvalue()
+        # If current stream was restored but our capture still has data
+        print("*WARN* Stream capture was interrupted", file=sys.stderr)
+        if hasattr(original_capture, 'getvalue'):
+            return original_capture.getvalue()
+        else:
+            return ""
 
 
 class KeywordResult(object):

pabot/skip_listener.py

@@ -0,0 +1,7 @@
+ROBOT_LISTENER_API_VERSION = 3
+
+def end_test(data, result):
+    # data: TestCase object
+    # result: TestCaseResult object
+    result.status = 'SKIP'
+    result.message = "Pabot skip logic: this test was skipped due to dependencies and failure policy."

pabot/timeout_listener.py

@@ -0,0 +1,5 @@
+ROBOT_LISTENER_API_VERSION = 3
+
+def end_test(data, result):
+    result.status = 'FAIL'
+    result.message = "Pabot's --processtimeout option has been reached."

pabot/writer.py

@@ -0,0 +1,110 @@
+import threading
+import queue
+import sys
+import os
+import time
+
+class Color:
+    RED = "\033[91m"
+    GREEN = "\033[92m"
+    YELLOW = "\033[93m"
+    ENDC = "\033[0m"
+    SUPPORTED_OSES = {"posix"}  # Only Unix terminals support ANSI colors
+
+
+class MessageWriter:
+    def __init__(self, log_file=None):
+        self.queue = queue.Queue()
+        self.log_file = log_file
+        if log_file:
+            os.makedirs(os.path.dirname(log_file), exist_ok=True)
+        self._stop_event = threading.Event()
+        self.thread = threading.Thread(target=self._writer)
+        self.thread.daemon = True
+        self.thread.start()
+
+    def _is_output_coloring_supported(self):
+        return sys.stdout.isatty() and os.name in Color.SUPPORTED_OSES
+
+    def _wrap_with(self, color, message):
+        if self._is_output_coloring_supported() and color:
+            return f"{color}{message}{Color.ENDC}"
+        return message
+
+    def _writer(self):
+        while not self._stop_event.is_set():
+            try:
+                message, color = self.queue.get(timeout=0.1)
+            except queue.Empty:
+                continue
+            if message is None:
+                self.queue.task_done()
+                break
+            print(self._wrap_with(color, message))
+            sys.stdout.flush()
+            if self.log_file:
+                with open(self.log_file, "a", encoding="utf-8") as f:
+                    f.write(message + "\n")
+            self.queue.task_done()
+
+    def write(self, message, color=None):
+        self.queue.put((f"{message}", color))
+
+    def flush(self, timeout=5):
+        """
+        Wait until all queued messages have been written.
+
+        :param timeout: Optional timeout in seconds. If None, wait indefinitely.
+        :return: True if queue drained before timeout (or no timeout), False if timed out.
+        """
+        start = time.time()
+        try:
+            # Loop until Queue reports no unfinished tasks
+            while True:
+                # If writer thread died, break to avoid infinite loop
+                if not self.thread.is_alive():
+                    # Give one last moment for potential in-flight task_done()
+                    time.sleep(0.01)
+                    # If still unfinished, we can't do more
+                    return getattr(self.queue, "unfinished_tasks", 0) == 0
+
+                unfinished = getattr(self.queue, "unfinished_tasks", None)
+                if unfinished is None:
+                    # Fallback: call join once and return
+                    try:
+                        self.queue.join()
+                        return True
+                    except Exception:
+                        return False
+
+                if unfinished == 0:
+                    return True
+
+                if timeout is not None and (time.time() - start) > timeout:
+                    return False
+
+                time.sleep(0.05)
+        except KeyboardInterrupt:
+            # Allow tests/cli to interrupt flushing
+            return False
+
+    def stop(self):
+        """
+        Gracefully stop the writer thread and flush remaining messages.
+        """
+        self.flush()
+        self._stop_event.set()
+        self.queue.put((None, None))  # sentinel to break thread loop
+        self.thread.join(timeout=1.0)
+
+
+_writer_instance = None
+
+def get_writer(log_dir=None):
+    global _writer_instance
+    if _writer_instance is None:
+        if log_dir:
+            os.makedirs(log_dir, exist_ok=True)
+        log_file = os.path.join(log_dir or ".", "pabot_manager.log")
+        _writer_instance = MessageWriter(log_file=log_file)
+    return _writer_instance

{robotframework_pabot-5.1.0.dist-info → robotframework_pabot-5.2.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-pabot
-Version: 5.1.0
+Version: 5.2.0b1
 Summary: Parallel test runner for Robot Framework
 Home-page: https://pabot.org
 Download-URL: https://pypi.python.org/pypi/robotframework-pabot
@@ -12,17 +12,14 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Testing
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Robot Framework
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-License-File: LICENSE.txt
 Requires-Dist: robotframework>=3.2
 Requires-Dist: robotframework-stacktrace>=0.4.1
 Requires-Dist: natsort>=8.2.0
 Dynamic: download-url
-Dynamic: license-file
 
 # Pabot
 
@@ -47,7 +44,7 @@ A parallel executor for [Robot Framework](http://www.robotframework.org) tests.
 - [Contributing](#contributing-to-the-project)
 - [Command-line options](#command-line-options)
 - [PabotLib](#pabotlib)
-- [Controlling execution order](#controlling-execution-order-and-level-of-parallelism)
+- [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
 - [Programmatic use](#programmatic-use)
 - [Global variables](#global-variables)
 - [Output Files Generated by Pabot](#output-files-generated-by-pabot)
@@ -98,6 +95,12 @@ There are several ways you can help in improving this tool:
    - Report an issue or an improvement idea to the [issue tracker](https://github.com/mkorpela/pabot/issues)
    - Contribute by programming and making a pull request (easiest way is to work on an issue from the issue tracker)
 
+Before contributing, please read our detailed contributing guidelines:
+
+- [Contributing Guide](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Security Policy](SECURITY.md)
+
 ## Command-line options
 <!-- NOTE: 
 The sections inside these docstring markers are also used in Pabot's --help output.
@@ -114,7 +117,8 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
         --processtimeout num|
         --shard i/n|
         --artifacts extensions|--artifactsinsubfolders|
-        --resourcefile file|--argumentfile[num] file|--suitesfrom file|--ordering file|
+        --resourcefile file|--argumentfile[num] file|--suitesfrom file
+        --ordering <FILENAME> [static|dynamic] [skip|run_all]|
         --chunk|
         --pabotprerunmodifier modifier|
         --no-rebot|
@@ -124,7 +128,7 @@ pabot [--verbose|--testlevelsplit|--command .. --end-command|
 
 PabotLib remote server is started by default to enable locking and resource distribution between parallel test executions.
 
-Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#all-command-line-options) and also following pabot options:
+Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#command-line-options) and also following pabot options:
 
 **--verbose**     
   More output from the parallel execution.
@@ -202,8 +206,10 @@ Supports all [Robot Framework command line options](https://robotframework.org/r
   Optionally read suites from output.xml file. Failed suites will run first and longer running ones will be executed 
   before shorter ones.
 
-**--ordering [FILE PATH]**   
-  Optionally give execution order from a file.
+**--ordering [FILE PATH] [MODE] [FAILURE POLICY]**   
+  Optionally give execution order from a file. See README.md section: [Controlling execution order, mode and level of parallelism](#controlling-execution-order-mode-and-level-of-parallelism)
+  - MODE (optional): [static (default)|dynamic]
+  - FAILURE POLICY (optional, only in dynamic mode): [skip|run_all (default)]
 
 **--chunk**   
   Optionally chunk tests to PROCESSES number of robot runs. This can save time because all the suites will share the same 
@@ -245,6 +251,9 @@ These can be helpful when you must ensure that only one of the processes uses so
 
 PabotLib Docs are located at https://pabot.org/PabotLib.html.
 
+Note that PabotLib uses the XML-RPC protocol, which does not support all possible object types. 
+These limitations are described in the Robot Framework documentation in chapter [Supported argument and return value types](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#supported-argument-and-return-value-types).
+
 ### PabotLib example:
 
 test.robot
@@ -290,18 +299,28 @@ pabot call using resources from valueset.dat
 
       pabot --pabotlib --resourcefile valueset.dat test.robot
 
-### Controlling execution order and level of parallelism
+### Controlling execution order, mode, and level of parallelism
 
 .pabotsuitenames file contains the list of suites that will be executed.
-File is created during pabot execution if not already there.
-The file is a cache that pabot uses when re-executing same tests to speed up processing. 
-This file can be partially manually edited but easier option is to use ```--ordering FILENAME```.
-First 4 rows contain information that should not be edited - pabot will edit these when something changes.
-After this come the suite names.
+This file is created during pabot execution if it does not already exist. It acts as a cache to speed up processing when re-executing the same tests.
+The file can be manually edited partially, but a simpler and more controlled approach is to use:
+
+```bash
+--ordering <FILENAME> [static|dynamic] [skip|run_all]
+```
+
+- **FILENAME** – path to the ordering file.  
+- **mode** – optional execution mode, either `static` (default) or `dynamic`.  
+    - `static` executes suites in predefined stages.  
+    - `dynamic` executes tests as soon as all their dependencies are satisfied, allowing more optimal parallel execution.  
+- **failure_policy** – determines behavior when dependencies fail. Used only in dynamic mode. Optional:  
+    - `skip` – dependent tests are skipped if a dependency fails.  
+    - `run_all` – all tests run regardless of failures (default).  
 
-With ```--ordering FILENAME``` you can have a list that controls order also. The syntax is same as .pabotsuitenames file syntax but does not contain 4 hash rows that are present in .pabotsuitenames. 
+The ordering file syntax is similar to `.pabotsuitenames` but does not include the first 4 hash rows used by pabot. The ordering file defines the **execution order and dependencies** of suites and tests.  
+The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
 
-Note: The `--ordering` file is intended only for defining the execution order of suites and tests. The actual selection of what to run must still be done using options like `--test`, `--suite`, `--include`, or `--exclude`.
+#### Controlling execution order
 
 There different possibilities to influence the execution:
 
@@ -313,7 +332,7 @@ There different possibilities to influence the execution:
 --suite Top Suite
 ```
 
-  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-the-name) you can use either the new or old full test path. For example:
+  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-suite-name) you can use either the new or old full test path. For example:
 
 ```
 --test New Suite Name.Sub Suite.Test 1
@@ -323,8 +342,14 @@ OR
 
   * You can add a line with text `#WAIT` to force executor to wait until all previous suites have been executed.
   * You can group suites and tests together to same executor process by adding line `{` before the group and `}` after. Note that `#WAIT` cannot be used inside a group.
-  * You can introduce dependencies using the word `#DEPENDS` after a test declaration. This keyword can be used several times if it is necessary to refer to several different tests. The ordering algorithm is designed to preserve the exact user-defined order as closely as possible. However, if a test's execution dependencies are not yet satisfied, the test is postponed and moved to the earliest possible stage where all its dependencies are fulfilled. Please take care that in case of circular dependencies an exception will be thrown. Note that each `#WAIT` splits suites into separate execution blocks, and it's not possible to define dependencies for suites or tests that are inside another `#WAIT` block or inside another `{}` braces.
-  * Note: Within a group `{}`, neither execution order nor the `#DEPENDS` keyword currently works. This is due to limitations in Robot Framework, which is invoked within Pabot subprocesses. These limitations may be addressed in a future release of Robot Framework. For now, tests or suites within a group will be executed in the order Robot Framework discovers them — typically in alphabetical order.
+  * You can introduce dependencies using the word `#DEPENDS` after a test declaration. This keyword can be used several times if it is necessary to refer to several different tests. 
+      * The ordering algorithm is designed to preserve the exact user-defined order as closely as possible. However, if a test's execution dependencies are not yet satisfied, the test is postponed and moved to the earliest possible stage where all its dependencies are fulfilled. 
+      * Please take care that in case of circular dependencies an exception will be thrown. 
+      * Note that each `#WAIT` splits suites into separate execution blocks, and it's not possible to define dependencies for suites or tests that are inside another `#WAIT` block or inside another `{}` braces.
+      * Ordering mode effect to execution:
+        * **Dynamic mode** will schedule dependent tests as soon as all their dependencies are satisfied. Note that in dynamic mode `#WAIT` is ignored, but you can achieve same results with using only `#DEPENDS` keywords.
+        *  **Static mode** preserves stage barriers and executes the next stage only after all tests in the previous stage finish.
+      * Note: Within a group `{}`, neither execution order nor the `#DEPENDS` keyword currently works. This is due to limitations in Robot Framework, which is invoked within Pabot subprocesses. These limitations may be addressed in a future release of Robot Framework. For now, tests or suites within a group will be executed in the order Robot Framework discovers them — typically in alphabetical order.
   * An example could be:
 
 ```
@@ -378,7 +403,7 @@ where order.txt is:
 #SLEEP 8
 ```
 
-prints something like this:
+Possible output could be:
 
 ```
 2025-02-15 19:15:00.408321 [0] [ID:1] SLEEPING 6 SECONDS BEFORE STARTING Data 1.suite C
@@ -466,6 +491,7 @@ pabot_results/
 │       ├── robot_stdout.out
 │       ├── robot_stderr.out
 │       └── artifacts...
+pabot_manager.log            # Pabot's own main log. Basically same than prints in console
 ```
 
 Each `PABOTQUEUEINDEX` folder contains as default:

robotframework_pabot-5.2.0b1.dist-info/RECORD

@@ -0,0 +1,25 @@
+pabot/ProcessManager.py,sha256=w3dgtEKGhn4rj3nQ1EEQFAPeiIv6OF-KU6R3WZwQxPs,11739
+pabot/SharedLibrary.py,sha256=mIipGs3ZhKYEakKprcbrMI4P_Un6qI8gE7086xpHaLY,2552
+pabot/__init__.py,sha256=KuCXsD2BDgEFiQAxVRLN3SXkkyCULXtW06tTTqCEuRo,202
+pabot/arguments.py,sha256=6MBXKnbDgWNdu7NnRqqd2_GNOs-u8QOxCz9wHhyfUVI,11404
+pabot/clientwrapper.py,sha256=yz7battGs0exysnDeLDWJuzpb2Q-qSjitwxZMO2TlJw,231
+pabot/coordinatorwrapper.py,sha256=nQQ7IowD6c246y8y9nsx0HZbt8vS2XODhPVDjm-lyi0,195
+pabot/execution_items.py,sha256=zDVGW0AAeVbM-scC3Yui2TxvIPx1wYyFKHTPU2BkJkY,13329
+pabot/pabot.py,sha256=hfMZdMYmeZEo3mNAVrvmuPU9vGhKpIBEVq5R8BI5ovE,87438
+pabot/pabotlib.py,sha256=vHbqV7L7mIvDzXBh9UcdULrwhBHNn70EDXF_31MNFO4,22320
+pabot/result_merger.py,sha256=g4mm-BhhMK57Z6j6dpvfL5El1g5onOtfV4RByNrO8g0,9744
+pabot/robotremoteserver.py,sha256=BdeIni9Q4LJKVDBUlG2uJ9tiyAjrPXwU_YsPq1THWoo,23296
+pabot/skip_listener.py,sha256=xv7wH-yB_nfc_AT1oZh3C0iu8hS67g5a28x8hwSrYsE,254
+pabot/timeout_listener.py,sha256=twZFiJEyn9tAqI1K6JDBGaZrxRqVLFDVWvyxa6d8Lb0,160
+pabot/workerwrapper.py,sha256=BdELUVDs5BmEkdNBcYTlnP22Cj0tUpZEunYQMAKyKWU,185
+pabot/writer.py,sha256=_sRN_EqIhaMwPYmTkN4NzO2Mj6tggcaxgYkqJKatb_c,3639
+pabot/py3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pabot/py3/client.py,sha256=Od9L4vZ0sozMHq_W_ITQHBBt8kAej40DG58wnxmbHGM,1434
+pabot/py3/coordinator.py,sha256=kBshCzA_1QX_f0WNk42QBJyDYSwSlNM-UEBxOReOj6E,2313
+pabot/py3/messages.py,sha256=7mFr4_0x1JHm5sW8TvKq28Xs_JoeIGku2bX7AyO0kng,2557
+pabot/py3/worker.py,sha256=5rfp4ZiW6gf8GRz6eC0-KUkfx847A91lVtRYpLAv2sg,1612
+robotframework_pabot-5.2.0b1.dist-info/METADATA,sha256=_7b2wWKxeuFlEbRCz_sHwmrWQCwp85v-rl9HX-mScyo,23811
+robotframework_pabot-5.2.0b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+robotframework_pabot-5.2.0b1.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
+robotframework_pabot-5.2.0b1.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
+robotframework_pabot-5.2.0b1.dist-info/RECORD,,

robotframework_pabot-5.1.0.dist-info/RECORD

@@ -1,22 +0,0 @@
-pabot/SharedLibrary.py,sha256=mIipGs3ZhKYEakKprcbrMI4P_Un6qI8gE7086xpHaLY,2552
-pabot/__init__.py,sha256=0g7UY0dKCwXzo3sH_STKWVLBEVtZnj96gmuak8fdlf0,200
-pabot/arguments.py,sha256=M1T2QAA0v2BO1bbryLC82RIA0VZZaEGfXnQiXfNcHOU,9577
-pabot/clientwrapper.py,sha256=yz7battGs0exysnDeLDWJuzpb2Q-qSjitwxZMO2TlJw,231
-pabot/coordinatorwrapper.py,sha256=nQQ7IowD6c246y8y9nsx0HZbt8vS2XODhPVDjm-lyi0,195
-pabot/execution_items.py,sha256=zDVGW0AAeVbM-scC3Yui2TxvIPx1wYyFKHTPU2BkJkY,13329
-pabot/pabot.py,sha256=wxkCGUzvibj7Jtdqhuyzo7F5k5xOPgVXICWZXbt7cn8,81246
-pabot/pabotlib.py,sha256=vHbqV7L7mIvDzXBh9UcdULrwhBHNn70EDXF_31MNFO4,22320
-pabot/result_merger.py,sha256=g4mm-BhhMK57Z6j6dpvfL5El1g5onOtfV4RByNrO8g0,9744
-pabot/robotremoteserver.py,sha256=L3O2QRKSGSE4ux5M1ip5XJMaelqaxQWJxd9wLLdtpzM,22272
-pabot/workerwrapper.py,sha256=BdELUVDs5BmEkdNBcYTlnP22Cj0tUpZEunYQMAKyKWU,185
-pabot/py3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pabot/py3/client.py,sha256=Od9L4vZ0sozMHq_W_ITQHBBt8kAej40DG58wnxmbHGM,1434
-pabot/py3/coordinator.py,sha256=kBshCzA_1QX_f0WNk42QBJyDYSwSlNM-UEBxOReOj6E,2313
-pabot/py3/messages.py,sha256=7mFr4_0x1JHm5sW8TvKq28Xs_JoeIGku2bX7AyO0kng,2557
-pabot/py3/worker.py,sha256=5rfp4ZiW6gf8GRz6eC0-KUkfx847A91lVtRYpLAv2sg,1612
-robotframework_pabot-5.1.0.dist-info/licenses/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-robotframework_pabot-5.1.0.dist-info/METADATA,sha256=-3nvXfoJrNCoqf6XVZccsiGhqiU8quQWI3cGk_RV0hY,22070
-robotframework_pabot-5.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-robotframework_pabot-5.1.0.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
-robotframework_pabot-5.1.0.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
-robotframework_pabot-5.1.0.dist-info/RECORD,,

robotframework_pabot-5.1.0.dist-info/licenses/LICENSE.txt

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