Merge ~kissiel/pigbox:dev into pigbox:master

[Maciej Kisielewski]

Basic functionality implementation.

Prepare doesn't do anything yet as I need to work out where to store stateful info.

[Sylvain Pineau (sylvain-pineau)]

LGTM

review: Approve

Unmerged commits

f58f5b4... by Maciej Kisielewski on 2019-09-19

implement basic functionality

207d8e9... by Maciej Kisielewski on 2019-09-18

add basic subcmd skeleton

diff --git a/pigbox/__init__.py b/pigbox/__init__.py
index 559fbb7..d622e65 100644
--- a/pigbox/__init__.py
+++ b/pigbox/__init__.py
@@ -1,2 +1,66 @@
+# Copyright 2019 Canonical Ltd.
+# Written by:
+#   Maciej Kisielewski <[e-mail]>
+#
+# Checkbox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3,
+# as published by the Free Software Foundation.
+#
+# Checkbox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
+import argparse
+import subprocess
+import sys
+
+from pigbox.capabilities import has_hdmi_bridge
+
+class Pigbox:
+    def prepare(self):
+        parser = argparse.ArgumentParser(
+            description="Prepare PIG for running tests"
+        )
+        parser.add_argument(
+            'teardown_command', help="Command to run after testing"
+        )
+        parser.add_argument(
+            'prepare_command', help="Command that prepares the PIG environment"
+        )
+        args = parser.parse_args(sys.argv[2:])
+    def run(self):
+        parser = argparse.ArgumentParser(
+            description="Run command in the PIG environment"
+        )
+        parser.add_argument('command', help="Command to run")
+        args = parser.parse_args(sys.argv[2:])
+        subprocess.run(args.command, shell=True)
+    def teardown(self):
+        parser = argparse.ArgumentParser(
+            description="Clear the PIG environment"
+        )
+        args = parser.parse_args(sys.argv[2:])
+    def capabilities(self):
+        parser = argparse.ArgumentParser(
+            description="List capabilities currently available"
+        )
+        args = parser.parse_args(sys.argv[2:])
+        if has_hdmi_bridge():
+            print("hdmi_bridge: installed")
+        print()
+
+
 def main():
-    return
+    parser = argparse.ArgumentParser(
+        description="Control PI testing riG",
+        usage="{} <ACTION> [COMMAND] ...".format(sys.argv[0]),
+    )
+    parser.add_argument('action', help="Action to run")
+    args = parser.parse_args(sys.argv[1:2])
+    app = Pigbox()
+    if not hasattr(app, args.action):
+        raise SystemExit("Unknown action '{}'".format(args.action))
+    return getattr(app, args.action)()
diff --git a/pigbox/capabilities.py b/pigbox/capabilities.py
new file mode 100644
index 0000000..5701eb4
--- /dev/null
+++ b/pigbox/capabilities.py
@@ -0,0 +1,49 @@
+# Copyright 2019 Canonical Ltd.
+# Written by:
+#   Maciej Kisielewski <[e-mail]>
+#
+# Checkbox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3,
+# as published by the Free Software Foundation.
+#
+# Checkbox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
+import subprocess
+import sys
+
+def has_hdmi_bridge():
+    # the heuristic here is based on `v4l2-ctl --info-edid` output
+    # I found three known responses, depending on the state:
+    # 1. command returns nothing and the error code is 0 when there is no hdmi
+    #    bridge connected
+    # 2. command returns an error (error code 255) and some message(s) if
+    #    the bridge is connected, but it hasn't been programmed with any EDID
+    #    info yet (for instance after a reboot)
+    # 3. command returns no error and prints out edid info when the bridge
+    #    is connected and operational
+    try:
+        output = subprocess.check_output(
+            ['v4l2-ctl', '--info-edid'], stderr=subprocess.PIPE
+        ).decode(sys.stdout.encoding)
+    except subprocess.CalledProcessError as exc:
+        if exc.returncode == 255:
+            # case 2. EDID not programmed, but the bridge's there
+            return True
+        elif exc.returncode == 1:
+            print("There was a problem with v4l2-ctl invocation",
+                  file=sys.stderr)
+            print(exc.stderr.decode(sys.stderr.encoding), file=sys.stderr)
+            return False
+    except FileNotFoundError:
+        print("v4l2-ctl not found", file=sys.stderr)
+        return False
+    if not output:
+        # case 1.
+        return False
+    # case 3.
+    return True