feat: add basic tests and instalation files

Author: jan-beranek

.env.example

@@ -0,0 +1,13 @@
+# Mandatory environment variables
+WOPEE_PROJECT_URL=https://dronjo.wopee.io/ # Base url of your project
+WOPEE_PROJECT_UUID=put-your-project-uuid-here # Get your Project UUID from PROJECT SETTINGS / API keys
+# WOPEE_API_KEY= # Wopee project API key should be provided via secret environmet variable
+# GITHUB_TOKEN= # GitHub token is used in .npmrc file to download public packages from GitHub Package Registry
+
+# Optional environment variables
+# WOPEE_BRANCH_NAME=master
+# WOPEE_CI_BUILD_ID=build-123
+# WOPEE_CUSTOM_TAGS=custom-tag
+# WOPEE_ENABLE_SOFT_ASSERT=true
+# WOPEE_PIXEL_TO_PIXEL_DIFF_TOLERANCE=0.1
+# WOPEE_API_URL=https://api.wopee.io/

.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Run Robot Framework tests
+
+on:
+  workflow_dispatch:
+    inputs:
+      robot-file:
+        description: 'Select robot file with tests to run'
+        type: choice
+        options:
+          - tests/01-main.robot
+          - tests/02-dronjo-simple.robot
+          - tests/03-dronjo-advanced.robot
+        required: true
+        default: tests/01-main.robot
+
+jobs:
+    configure:
+        runs-on: ubuntu-latest
+        outputs:
+            uid_gid: ${{ env.UID_GID }}
+        steps:
+          - id: get-user
+            run: echo "UID_GID=$(id -u):$(id -g)" >> $GITHUB_ENV
+
+    test:
+        runs-on: ubuntu-latest
+        needs: configure
+        container: 
+            image: ghcr.io/wopee-io/runtime
+            options: --user ${{ needs.configure.outputs.uid_gid }}
+
+        steps:
+          - uses: actions/checkout@v4
+
+          - name: Run tests
+            env:
+                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                WOPEE_API_KEY: ${{ secrets.WOPEE_API_KEY }}
+                WOPEE_API_URL: ${{ vars.WOPEE_API_URL || 'https://api.wopee.io' }}
+                WOPEE_PROJECT_UUID: ${{ vars.WOPEE_PROJECT_UUID }}
+                WOPEE_PROJECT_URL: ${{ vars.WOPEE_PROJECT_URL || 'https://dronjo.wopee.io' }}
+                # WOPEE_SCREENSHOT_VALIDATION_ENABLED: "true"
+                # WOPEE_BRANCH_NAME: master
+                # WOPEE_CI_BUILD_ID: build-123
+                # WOPEE_CUSTOM_TAGS: custom-tag
+                # WOPEE_ENABLE_SOFT_ASSERT: "true"
+                # WOPEE_PIXEL_TO_PIXEL_DIFF_TOLERANCE: "0.1"
+            run: robot ${{ github.event.inputs.robot-file }}

.gitignore

@@ -1,3 +1,7 @@
+# Wopee.rf
+screenshots
+wopee_rf-*.tar.gz
+
 # Robot Report
 log.html
 output.xml

Makefile

@@ -0,0 +1,12 @@
+install:
+	python -m venv .venv && \
+	source .venv/bin/activate && \
+	pip install -r requirements.txt && \
+	cp .env.example .env
+
+test:
+	source .venv/bin/activate && \
+	robot tests/
+
+clean:
+	rm -rf reports/

requirements.txt

@@ -0,0 +1,2 @@
+robotframework-seleniumlibrary
+wopee_rf-1.1.0.tar.gz

tests/agnostic_standalone.robot

@@ -0,0 +1,35 @@
+*** Settings ***
+Library     SeleniumLibrary
+Library     wopee_rf.Wopee    dot_env_path=.env
+
+
+*** Test Cases ***
+Test Browser Framework Agnostic Track
+    Open Browser    https://wopee.io    headlesschrome
+    Set Screenshot Directory    screenshots/selenium
+
+    ${timestamp}    Generate Timestamp
+
+    Start Suite    suite_name=Suite name-${timestamp}
+    Start Scenario    scenario_name=Scenario name-${timestamp}
+
+    ${image_path}    Capture Page Screenshot
+    ${image_base64}    Convert Image to Base64    ${image_path}
+
+    &{payload}    Create Dictionary    image_base64=${image_base64}    step_name=Step name-${timestamp}
+    ${track_result}    Track    payload=&{payload}
+
+    Stop Scenario
+
+
+*** Keywords ***
+Convert Image to Base64
+    [Arguments]    ${image_path}
+    ${image_base64}    Evaluate
+    ...    sys.modules['base64'].b64encode(open(r"${image_path}", 'rb').read()).decode('utf-8')
+    ...    base64
+    RETURN    ${image_base64}
+
+Generate Timestamp
+    ${timestamp}    Evaluate    int(datetime.datetime.now().timestamp())    datetime
+    RETURN    ${timestamp}