sefrone-api-e2e 1.1.3__tar.gz → 1.1.4__tar.gz

{sefrone_api_e2e-1.1.3 → sefrone_api_e2e-1.1.4}/PKG-INFO

@@ -1,19 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sefrone_api_e2e
-Version: 1.1.3
+Version: 1.1.4
 Summary: A Python package to provide e2e testing helpers for sefrone API projects
 Home-page: https://bitbucket.org/sefrone/sefrone_pypi
 Author: Sefrone
 Author-email: contact@sefrone.com
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 This is not a usable Python package, but the name is reserved by SARL Sefrone.
 
 You can find other packages published by Sefrone at pypi.org/user/gnasreddine
-

{sefrone_api_e2e-1.1.3 → sefrone_api_e2e-1.1.4}/sefrone_api_e2e/__init__.py

@@ -2,6 +2,7 @@ from .api_e2e_manager import ApiE2ETestsManager, ScenarioSkippedException
 from .step_runner import StepRunner, RunContext, StepResult
 from .runner_rest_api import RestApiRunner
 from .runner_email_mock import EmailMockRunner
+from .runner_webhook_mock import WebhookMockRunner
 from .json_mock_server import JsonMockServer
 from .e2e_scenarios_manager import E2EScenariosManager
 
@@ -13,6 +14,7 @@ __all__ = [
     "StepResult",
     "RestApiRunner",
     "EmailMockRunner",
+    "WebhookMockRunner",
     "JsonMockServer",
     "E2EScenariosManager",
 ]

sefrone_api_e2e-1.1.4/sefrone_api_e2e/e2e/Scenarios/Auth/0_check_features.yaml

@@ -0,0 +1,19 @@
+name: "Check Auth Features"
+base_url: "http://localhost:$var(API_PUBLIC_PORT)"
+steps:
+  - name: "Get enabled auth features"
+    retry:
+      attempts: 10
+      delay_seconds: 5
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/features"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          features: []
+    save:
+      enabled_features: "{{body.response.features}}"

sefrone_api_e2e-1.1.4/sefrone_api_e2e/e2e/Scenarios/Auth/1_normal_auth_flow.yaml

@@ -0,0 +1,377 @@
+name: "Auth Flow"
+base_url: "http://localhost:$var(API_PUBLIC_PORT)"
+steps:
+  - name: "Login user"
+    retry:
+      attempts: 10
+      delay_seconds: 5
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "$var(DEFAULT_USERNAME)"
+      password: "$var(DEFAULT_PASSWORD)"
+    expect:
+      status: 200
+      body:
+        response:
+          token: string
+    save:
+      login_token: "{{body.response.token}}"
+
+  - name: "Generate unique test suffix"
+    randomize:
+      seed_id: 8
+
+  - name: "Get user info"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/info/{$stored.login_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces:
+            - workspaceId: string
+              workspaceName: string
+              workspaceDescription: string
+          permissions:
+            Projects: string
+            Workspaces: string
+            ListWorkspaces: string
+            Accounts: string
+            ApiKeys: string
+            AuthStats: string
+            AccountState: string
+            ChangeAccountPermissions: string
+            ChangeAccountCredentials: string
+          token: string
+          tokenExpiryDate: datetime
+    save:
+      login_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.username}} == 'admin'"
+      - "{{body.response.isActive}} == True"
+      - "{{body.response.accountType}} == 'root'"
+      - "{{body.response.credentialType}} == 'standard'"
+
+  - name: "Get user permissions"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/permission/{$stored.login_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.login_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          permissions:
+            Projects: string
+            Workspaces: string
+            ListWorkspaces: string
+            Accounts: string
+            ApiKeys: string
+            AuthStats: string
+            AccountState: string
+            ChangeAccountPermissions: string
+            ChangeAccountCredentials: string
+
+  - name: "Get user info using deprecated login check endpoint"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login/check/{$stored.login_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces:
+            - workspaceId: string
+              workspaceName: string
+              workspaceDescription: string
+          permissions:
+            Projects: string
+            Workspaces: string
+            ListWorkspaces: string
+            Accounts: string
+            ApiKeys: string
+            AuthStats: string
+            AccountState: string
+            ChangeAccountPermissions: string
+            ChangeAccountCredentials: string
+          token: string
+          tokenExpiryDate: datetime
+    assertions:
+      - "{{body.response.accountId}} == '{$stored.login_account_id}'"
+      - "{{body.response.username}} == 'admin'"
+      - "{{body.response.accountType}} == 'root'"
+
+  - name: "Create guest account"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/guest"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces: []
+          token: string
+          tokenExpiryDate: datetime
+    save:
+      guest_token: "{{body.response.token}}"
+      guest_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'guest'"
+      - "{{body.response.credentialType}} == 'guest'"
+      - "{{body.response.isActive}} == True"
+      - "{{body.response.username}} include 'Guest_'"
+      - "{{body.response.linkedWorkspaces.count()}} == 0"
+
+  - name: "Get same guest account with existing token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/guest"
+    request_headers:
+      - x-api-token: "{$stored.guest_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces: []
+          token: string
+          tokenExpiryDate: datetime
+    assertions:
+      - "{{body.response.accountId}} == '{$stored.guest_account_id}'"
+      - "{{body.response.token}} == '{$stored.guest_token}'"
+      - "{{body.response.accountType}} == 'guest'"
+      - "{{body.response.linkedWorkspaces.count()}} == 0"
+
+  - name: "Create guest account for workspace"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/guest"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces:
+            - workspaceId: string
+              workspaceName: string
+              workspaceDescription: string
+          token: string
+          tokenExpiryDate: datetime
+    save:
+      workspace_guest_token: "{{body.response.token}}"
+      workspace_guest_account_id: "{{body.response.accountId}}"
+    assertions:
+      - "{{body.response.accountType}} == 'guest'"
+      - "{{body.response.credentialType}} == 'guest'"
+      - "{{body.response.linkedWorkspaces.count()}} == 1"
+      - "{{body.response.linkedWorkspaces[0].workspaceName}} == '$var(DEFAULT_WORKSPACE_NAME)'"
+
+  - name: "Get same workspace guest account with existing token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/guest"
+    request_headers:
+      - x-api-token: "{$stored.workspace_guest_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces:
+            - workspaceId: string
+              workspaceName: string
+              workspaceDescription: string
+          token: string
+          tokenExpiryDate: datetime
+    assertions:
+      - "{{body.response.accountId}} == '{$stored.workspace_guest_account_id}'"
+      - "{{body.response.token}} == '{$stored.workspace_guest_token}'"
+      - "{{body.response.linkedWorkspaces.count()}} == 1"
+      - "{{body.response.linkedWorkspaces[0].workspaceName}} == '$var(DEFAULT_WORKSPACE_NAME)'"
+
+  - name: "Register standard account"
+    skip_if:
+      - "PseudoRegister not in {$stored.0_check_features.enabled_features}"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)"
+    send_as: "json"
+    body:
+      username: "e2e_new_user_{$stored.seed_id}"
+      password: "e2e_test_password"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces: []
+    save:
+      registered_account_id: "{{body.response.accountId}}"
+      registered_username: "{{body.response.username}}"
+    assertions:
+      - "{{body.response.accountType}} == 'standard'"
+      - "{{body.response.credentialType}} == 'standard'"
+      - "{{body.response.isActive}} == True"
+      - "{{body.response.linkedWorkspaces.count()}} == 0"
+      - "{{body.response.username}} include 'e2e_new_user_'"
+
+  - name: "Login with wrong password"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "$var(DEFAULT_USERNAME)"
+      password: "wrong_password"
+    expect:
+      status: 401
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Logout current token"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/logout/{$stored.login_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Logout guest token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/logout/{$stored.guest_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Try getting guest info with revoked token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/info/{$stored.guest_token}"
+    expect:
+      status: 401
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Logout workspace guest token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/logout/{$stored.workspace_guest_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Try getting workspace guest info with revoked token"
+    skip_if:
+      - "GuestAccount not in {$stored.0_check_features.enabled_features}"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/info/{$stored.workspace_guest_token}"
+    expect:
+      status: 401
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Try getting auth info with revoked token"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/info/{$stored.login_token}"
+    expect:
+      status: 401
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string

sefrone_api_e2e-1.1.4/sefrone_api_e2e/e2e/Scenarios/Auth/2_account_endpoints.yaml

@@ -0,0 +1,172 @@
+name: "Account Endpoints Flow"
+base_url: "http://localhost:$var(API_PUBLIC_PORT)"
+steps:
+  - name: "Login admin user"
+    retry:
+      attempts: 10
+      delay_seconds: 5
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "$var(DEFAULT_USERNAME)"
+      password: "$var(DEFAULT_PASSWORD)"
+    expect:
+      status: 200
+      body:
+        response:
+          token: string
+    save:
+      admin_token: "{{body.response.token}}"
+
+  - name: "Generate unique test suffix"
+    randomize:
+      guest_seed_account_id: 8
+
+  - name: "Create account by workspace"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/create"
+    request_headers:
+      - x-api-token: "{$stored.admin_token}"
+    send_as: "json"
+    body:
+      username: "e2e_account_{$stored.guest_seed_account_id}"
+      password: "e2e_account_pwd_v1"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+          project: string
+          accountType: string
+          credentialType: string
+          isActive: boolean
+          username: string
+          linkedWorkspaces:
+            - workspaceId: string
+              workspaceName: string
+              workspaceDescription: string
+    save:
+      managed_account_id: "{{body.response.accountId}}"
+      managed_account_username: "{{body.response.username}}"
+    assertions:
+      - "{{body.response.accountType}} == 'standard'"
+      - "{{body.response.credentialType}} == 'standard'"
+      - "{{body.response.isActive}} == True"
+      - "{{body.response.linkedWorkspaces.count()}} == 1"
+      - "{{body.response.linkedWorkspaces[0].workspaceName}} == '$var(DEFAULT_WORKSPACE_NAME)'"
+
+  - name: "Get created account permissions"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "GET"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/permission/{$stored.managed_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.admin_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          projectId: string
+    assertions:
+      - "{{body.response.accountId}} == '{$stored.managed_account_id}'"
+
+  - name: "Update created account by workspace"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/update/{$stored.managed_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.admin_token}"
+    send_as: "json"
+    body:
+      username: "e2e_updated_{$stored.guest_seed_account_id}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Set created account credentials by workspace"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/credentials/{$stored.managed_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.admin_token}"
+    send_as: "json"
+    body:
+      password: "e2e_account_pwd_v2"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Login updated account with new credentials"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "e2e_updated_{$stored.guest_seed_account_id}"
+      password: "e2e_account_pwd_v2"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+        response:
+          accountId: string
+          token: string
+    save:
+      managed_account_token: "{{body.response.token}}"
+    assertions:
+      - "{{body.response.accountId}} == '{$stored.managed_account_id}'"
+
+  - name: "Delete created account by workspace"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "DELETE"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/workspace/$var(DEFAULT_WORKSPACE_NAME)/delete/{$stored.managed_account_id}"
+    request_headers:
+      - x-api-token: "{$stored.admin_token}"
+    expect:
+      status: 200
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string
+
+  - name: "Login should fail for deleted account"
+    skip_if:
+      - "'$var(DEFAULT_WORKSPACE_NAME)' == ''"
+    method: "POST"
+    endpoint: "/api/v1/apiAuth/account/$var(AUTH_PROJECT_NAME)/login"
+    send_as: "json"
+    body:
+      device: "e2e_test_device"
+      pseudo: "e2e_updated_{$stored.guest_seed_account_id}"
+      password: "e2e_account_pwd_v2"
+    expect:
+      status: 401
+      body:
+        errorCode: number
+        errorCodeStr: string
+        message: string