ci: add new tests and CI setup for capmonster tasks

Author: alperensert

.github/dependabot.yml

@@ -1,12 +1,6 @@
 version: 2
 updates:
   - package-ecosystem: "pip"
-    directory: "/capmonster_python"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "npm"
-    directory: "/docs"
+    directory: "/src/capmonster_python"
     schedule:
       interval: "weekly"
-    ignore:
-      - dependency-name: "*"

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Run Pytest Tests
+
+on:
+  push:
+    branches: [ "master" ]
+    paths:
+      - "tests/**"
+      - ".github/workflows/test.yml"
+      - "**.py"
+  pull_request:
+    branches: [ "master" ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    env:
+      API_KEY: ${{ secrets.API_KEY }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install pytest
+
+      - name: Run tests
+        run: |
+          pytest tests/

src/capmonster_python/methods.py

@@ -10,8 +10,8 @@ class GetBalancePayload(BaseModel):
     Represents a payload for retrieving the balance.
 
     Attributes:
-    clientKey (str): The key representing the client, used for identifying
-    the client in balance-related operations.
+        clientKey (str): The key representing the client, used for identifying
+            the client in balance-related operations.
     """
     clientKey: str = Field(..., description="Client key")
 

tests/complex_image_recognition_test.py

@@ -0,0 +1,12 @@
+from capmonster_python import ComplexImageRecognitionTask
+
+
+def test_to_request():
+    task = ComplexImageRecognitionTask(
+        imagesBase64=["first", "second", "third"],
+        task="oocl_rotate_double_new"
+    )
+    result = task.to_request()
+    assert result["type"] == "ComplexImageTask"
+    assert result["class"] == "recognition"
+    assert result["metadata"]["Task"] == "oocl_rotate_double_new"

tests/datadome_test.py

@@ -0,0 +1,44 @@
+import os
+
+import pytest
+
+from capmonster_python import DataDomeTask, DataDomeMetadata, CapmonsterClient
+
+API_KEY = os.getenv("API_KEY")
+WEBSITE_URL = "https://antoinevastel.com/bots/datadome"
+METADATA = DataDomeMetadata(
+    captchaUrl="https://geo.captcha-delivery.com/captcha/?initialCid=AHrlqAAAAAMAJxx4dfgwjzwAQW0ctQ%3D%3D&hash"
+               "=D66B23AC3F48A302A7654416846381&cid=d3k5rbDsu8cq0kmPHISS3hsC3f4qeL_K12~G33PrE4fbkmDYSul6l0Ze_aG5sUHLKG0676UpTv6GFvUgIActglZF33GTodOoRhEDkMMsuWTodlYa3YYQ9xKy9J89PAWh&t=fe&referer=https%3A%2F%2Fantoinevastel.com%2Fbots%2Fdatadome&s=21705&e=04fc682817ba89bf8fa4b18031fa53294fa0fb7449d95c036a1986413e6dfc7d",
+    datadomeCookie="datadome=d3k5rbDsu8cq0kmPHISS3hsC3f4qeL_K12~G33PrE4fbkmDYSul6l0Ze_aG5sUHLKG0676UpTv6GFvUgIActglZF33GTodOoRhEDkMMsuWTodlYa3YYQ9xKy9J89PAWh"
+)
+
+
+def test_to_request():
+    task = DataDomeTask(
+        websiteURL="https://example.com",
+        metadata=DataDomeMetadata(
+            htmlPageBase64="base64_example",
+            datadomeCookie="cookie1=value1; cookie2=value2;"
+        )
+    )
+    result = task.to_request()
+    assert result["type"] == "CustomTask"
+    assert result["class"] == "DataDome"
+    assert result["metadata"]["htmlPageBase64"] == "base64_example"
+    assert result["metadata"]["datadomeCookie"] == "cookie1=value1; cookie2=value2;"
+
+
+@pytest.mark.skipif(API_KEY is None, reason="API_KEY is not set")
+async def test_create_task_async():
+    client = CapmonsterClient(API_KEY, timeout=30.0)
+    task_id = client.create_task(task=DataDomeTask(websiteURL=WEBSITE_URL, metadata=METADATA))
+    assert task_id != 0
+    assert task_id != 0
+
+
+@pytest.mark.asyncio
+@pytest.mark.skipif(API_KEY is None, reason="API_KEY is not set")
+async def test_create_task_async():
+    client = CapmonsterClient(API_KEY, timeout=30.0)
+    task_id = await client.create_task_async(task=DataDomeTask(websiteURL=WEBSITE_URL, metadata=METADATA))
+    assert task_id != 0

tests/geetest_test.py

@@ -0,0 +1,35 @@
+import os
+
+import pytest
+
+from capmonster_python import CapmonsterClient, GeeTestV4Task
+
+API_KEY = os.getenv("API_KEY")
+WEBSITE_URL = "https://faucetpay.io/account/logi"
+GT = "4eb8b0c2b27f3365b9244d9da81638c6"
+
+
+def test_to_request():
+    task = GeeTestV4Task(
+        websiteURL="https://example.com",
+        gt="gt_example"
+    )
+    result = task.to_request()
+    assert result["type"] == "GeeTestTask"
+    assert result["gt"] == "gt_example"
+    assert result["websiteURL"] == "https://example.com"
+
+
+@pytest.mark.skipif(API_KEY is None, reason="API_KEY is not set")
+async def test_create_task_async():
+    client = CapmonsterClient(API_KEY, timeout=30.0)
+    task_id = client.create_task(task=GeeTestV4Task(websiteURL=WEBSITE_URL, gt=GT))
+    assert task_id != 0
+
+
+@pytest.mark.asyncio
+@pytest.mark.skipif(API_KEY is None, reason="API_KEY is not set")
+async def test_create_task_async():
+    client = CapmonsterClient(API_KEY, timeout=30.0)
+    task_id = await client.create_task_async(task=GeeTestV4Task(websiteURL=WEBSITE_URL, gt=GT))
+    assert task_id != 0