fix: fix gitignore

Author: vectronic

.gitignore

@@ -176,5 +176,6 @@ dist
 docs/
 template-bun-executable
 /.releaserc
-functional_tests/features/support/__pycache__/pexpect_wrapper.cpython-311.pyc
+functional_tests/features/support/__pycache__
 example-host-application
+functional_tests/.venv

functional_tests/README.md

@@ -0,0 +1,23 @@
+## Executable Functional Tests
+
+#### Setup
+
+Ensure the executable is built:
+
+    bun build ../index.ts --compile --outfile /tmp/example-host-application
+
+Install requirements:
+
+    pip3 install -r pip-requirements.txt
+
+#### Testing
+
+Run the functional tests:
+
+    export EXECUTABLE=/tmp/example-host-application
+    behave
+
+To run with logging output from the test steps (this is the best set of
+arguments I can find):
+
+    behave --no-logcapture --no-color --logging-level=DEBUG

functional_tests/features/environment.py

@@ -0,0 +1,9 @@
+import os
+
+from support.pexpect_wrapper import PExpectWrapper
+
+
+def before_all(context):
+
+    context.config.setup_logging()
+    context.pexpect_wrapper = PExpectWrapper(os.environ.get('EXECUTABLE'))

functional_tests/features/executable.feature

@@ -0,0 +1,7 @@
+Feature: Executable
+
+  Scenario: Executable success
+    When the executable is launched
+    Then the executable should complete successfully
+    And the executable should have output "INFO Invoking extension"
+    And the executable should have output "INFO hello world"

functional_tests/features/steps/executable.py

@@ -0,0 +1,18 @@
+from behave import when, then
+
+
+@when('the executable is launched')
+def step_impl(context):
+    context.pexpect_wrapper.start()
+
+
+@then('the executable should complete successfully')
+def step_impl(context):
+    context.pexpect_wrapper.expect_eof()
+    status = context.pexpect_wrapper.complete()
+    assert status == 0, 'unexpected exit status: {}'.format(status)
+
+
+@then('the executable should have output "{message}"')
+def step_impl(context, message):
+    context.pexpect_wrapper.expect(message)

functional_tests/features/support/pexpect_wrapper.py

@@ -0,0 +1,45 @@
+from pexpect.popen_spawn import PopenSpawn
+from pexpect import EOF
+import logging
+log = logging.getLogger("pexpect_wrapper")
+
+
+class PExpectWrapper:
+
+    def __init__(self, executable):
+        self.executable = executable
+        self.child = None
+        self.output = None
+
+    def start(self):
+        assert self.child is None
+
+        self.child = PopenSpawn(self.executable, encoding='utf-8')
+
+    def expect(self, message):
+        assert self.child is not None
+
+        found = ''
+        while len(self.output) > 0:
+            next_line = self.output.pop(0)
+            log.debug('looking for "{}" in "{}"'.format(message, next_line))
+            if message in next_line:
+                found = next_line
+                break
+
+        assert found != '', 'expected {} in output'.format(message)
+
+
+    def expect_eof(self):
+        assert self.child is not None
+
+        self.child.expect(EOF)
+
+    def complete(self):
+        assert self.child is not None
+
+        exit_status = self.child.wait()
+
+        self.output = self.child.before.split('\n')
+
+        return exit_status

functional_tests/pip-requirements.txt

@@ -0,0 +1,2 @@
+pexpect
+behave