Add missing endpoints and separate generated code (#324)

Author: IgorChvyrov-sm

.github/workflows/pull_request.yml

@@ -68,6 +68,18 @@ jobs:
             conductor-sdk-test:latest \
             /bin/sh -c "cd /package && COVERAGE_FILE=/package/${{ env.COVERAGE_DIR }}/.coverage.serdeser coverage run -m pytest tests/serdesertest -v"
 
+      - name: Run integration tests
+        id: integration_tests
+        continue-on-error: true
+        run: |
+          docker run --rm \
+            -e CONDUCTOR_AUTH_KEY=${{ env.CONDUCTOR_AUTH_KEY }} \
+            -e CONDUCTOR_AUTH_SECRET=${{ env.CONDUCTOR_AUTH_SECRET }} \
+            -e CONDUCTOR_SERVER_URL=${{ env.CONDUCTOR_SERVER_URL }} \
+            -v ${{ github.workspace }}/${{ env.COVERAGE_DIR }}:/package/${{ env.COVERAGE_DIR }}:rw \
+            conductor-sdk-test:latest \
+            /bin/sh -c "cd /package && COVERAGE_FILE=/package/${{ env.COVERAGE_DIR }}/.coverage.integration coverage run -m pytest -m v4 tests/integration -v"
+
       - name: Generate coverage report
         id: coverage_report
         continue-on-error: true

.gitignore

@@ -161,8 +161,6 @@ latest.txt
 
 *.so
 
-codegen/
-
 .vscode/
 tests/unit/automator/_trial_temp/_trial_marker
 tests/unit/automator/_trial_temp/_trial_marker

README.md

@@ -82,6 +82,10 @@ Show support for the Conductor OSS.  Please help spread the awareness by starrin
     - [Example Unit Testing Application](#example-unit-testing-application)
   - [Workflow Deployments Using CI/CD](#workflow-deployments-using-cicd)
   - [Versioning Workflows](#versioning-workflows)
+- [Development](#development)
+  - [Client Regeneration](#client-regeneration)
+    - [Sync Client Regeneration](#sync-client-regeneration)
+    - [Async Client Regeneration](#async-client-regeneration)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -929,3 +933,32 @@ A powerful feature of Conductor is the ability to version workflows. You should
 
 * Versioning allows safely testing changes by doing canary testing in production or A/B testing across multiple versions before rolling out.
 * A version can also be deleted, effectively allowing for "rollback" if required.
+
+
+## Development
+
+### Client Regeneration
+
+When updating to a new Orkes version, you may need to regenerate the client code to support new APIs and features. The SDK provides comprehensive guides for regenerating both sync and async clients:
+
+#### Sync Client Regeneration
+
+For the synchronous client (`conductor.client`), see the [Client Regeneration Guide](src/conductor/client/CLIENT_REGENERATION_GUIDE.md) which covers:
+
+- Creating swagger.json files for new Orkes versions
+- Generating client code using Swagger Codegen
+- Replacing models and API clients in the codegen folder
+- Creating adapters and updating the proxy package
+- Running backward compatibility, serialization, and integration tests
+
+#### Async Client Regeneration
+
+For the asynchronous client (`conductor.asyncio_client`), see the [Async Client Regeneration Guide](src/conductor/asyncio_client/ASYNC_CLIENT_REGENERATION_GUIDE.md) which covers:
+
+- Creating swagger.json files for new Orkes versions
+- Generating async client code using OpenAPI Generator
+- Replacing models and API clients in the http folder
+- Creating adapters for backward compatibility
+- Running async-specific tests and handling breaking changes
+
+Both guides include detailed troubleshooting sections, best practices, and step-by-step instructions to ensure a smooth regeneration process while maintaining backward compatibility.

docs/authorization/README.md

@@ -18,7 +18,7 @@ authorization_client = OrkesAuthorizationClient(configuration)
 Creates an application and returns a ConductorApplication object.
 
 ```python
-from conductor.client.http.models.create_or_update_application_request import CreateOrUpdateApplicationRequest
+from conductor.client.http.models import CreateOrUpdateApplicationRequest
 from conductor.client.orkes.orkes_authorization_client import OrkesAuthorizationClient
 from conductor.client.configuration.configuration import Configuration
 
@@ -138,7 +138,7 @@ Creates or updates a user and returns a ConductorUser object.
 
 ```python
 from conductor.client.http.models.upsert_user_request import UpsertUserRequest
-from conductor.client.http.models.conductor_user import ConductorUser
+from conductor.client.http.models import ConductorUser
 
 user_id = 'test.user@company.com'
 user_name = "Test User"
@@ -171,8 +171,7 @@ authorization_client.delete_user(user_id)
 Creates or updates a user group and returns a Group object.
 
 ```python
-from conductor.client.http.models.upsert_group_request import UpsertGroupRequest
-from conductor.client.http.models.group import Group
+from conductor.client.http.models import UpsertGroupRequest, Group
 
 group_id = 'test_group'
 group_name = "Test Group"
@@ -225,9 +224,8 @@ authorization_client.remove_user_from_group(group_id, user_id)
 Grants a set of accesses to the specified Subject for a given Target.
 
 ```python
-from conductor.client.http.models.target_ref import TargetRef
+from conductor.client.http.models import TargetRef, SubjectRef
 from conductor.shared.http.enums.target_type import TargetType
-from conductor.client.http.models.subject_ref import SubjectRef
 from conductor.shared.http.enums.subject_type import SubjectType
 from conductor.client.orkes.models.access_type import AccessType
 
@@ -247,7 +245,7 @@ Given the target, returns all permissions associated with it as a Dict[str, List
 In the returned dictionary, key is AccessType and value is a list of subjects.
 
 ```python
-from conductor.client.http.models.target_ref import TargetRef
+from conductor.client.http.models import TargetRef
 from conductor.shared.http.enums.target_type import TargetType
 
 target = TargetRef(TargetType.WORKFLOW_DEF, WORKFLOW_NAME)
@@ -276,9 +274,8 @@ user_permissions = authorization_client.get_granted_permissions_for_user(user_id
 Removes a set of accesses from a specified Subject for a given Target.
 
 ```python
-from conductor.client.http.models.target_ref import TargetRef
+from conductor.client.http.models import TargetRef, SubjectRef
 from conductor.shared.http.enums.target_type import TargetType
-from conductor.client.http.models.subject_ref import SubjectRef
 from conductor.shared.http.enums.subject_type import SubjectType
 from conductor.client.orkes.models.access_type import AccessType
 

docs/metadata/README.md

@@ -57,7 +57,7 @@ workflow.input_parameters(["a", "b"])
 You should be able to register your workflow at the Conductor Server:
 
 ```python
-from conductor.client.http.models.workflow_def import WorkflowDef
+from conductor.client.http.models import WorkflowDef
 
 workflowDef = workflow.to_workflow_def()
 metadata_client.register_workflow_def(workflowDef, True)
@@ -98,7 +98,7 @@ metadata_client.unregister_workflow_def('python_workflow_example_from_code', 1)
 You should be able to register your task at the Conductor Server:
 
 ```python
-from conductor.client.http.models.task_def import TaskDef
+from conductor.client.http.models import TaskDef
 
 taskDef = TaskDef(
     name="PYTHON_TASK",

docs/schedule/README.md

@@ -21,8 +21,7 @@ scheduler_client = OrkesSchedulerClient(configuration)
 ### Saving Schedule
 
 ```python
-from conductor.client.http.models.save_schedule_request import SaveScheduleRequest
-from conductor.client.http.models.start_workflow_request import StartWorkflowRequest
+from conductor.client.http.models import SaveScheduleRequest, StartWorkflowRequest
 
 startWorkflowRequest = StartWorkflowRequest(
     name="WORKFLOW_NAME", workflow_def=workflowDef

docs/testing/README.md

@@ -16,7 +16,7 @@ A sample unit test code snippet is provided below.
 import json
 from conductor.shared.configuration.settings.authentication_settings import AuthenticationSettings
 from conductor.client.configuration.configuration import Configuration
-from conductor.client.http.models.workflow_test_request import WorkflowTestRequest
+from conductor.client.http.models import WorkflowTestRequest
 from conductor.client.orkes.orkes_workflow_client import OrkesWorkflowClient
 
 TEST_WF_JSON_PATH = 'tests/integration/resources/test_data/calculate_loan_workflow.json'

docs/worker/README.md

@@ -347,8 +347,7 @@ See [simple_cpp_lib.cpp](src/example/worker/cpp/simple_cpp_lib.cpp)
 and [simple_cpp_worker.py](src/example/worker/cpp/simple_cpp_worker.py) for complete working example.
 
 ```python
-from conductor.client.http.models.task import Task
-from conductor.client.http.models.task_result import TaskResult
+from conductor.client.http.models import Task, TaskResult
 from conductor.shared.http.enums import TaskResultStatus
 from conductor.client.worker.worker_interface import WorkerInterface
 from ctypes import cdll

examples/async/dynamic_workflow.py

@@ -7,9 +7,9 @@
 
 import asyncio
 
+from conductor.asyncio_client.adapters import ApiClient
 from conductor.asyncio_client.automator.task_handler import TaskHandler
 from conductor.asyncio_client.configuration.configuration import Configuration
-from conductor.asyncio_client.adapters import ApiClient
 from conductor.asyncio_client.orkes.orkes_clients import OrkesClients
 from conductor.asyncio_client.worker.worker_task import worker_task
 from conductor.asyncio_client.workflow.conductor_workflow import AsyncConductorWorkflow
@@ -31,6 +31,7 @@ async def main():
     # CONDUCTOR_AUTH_KEY : API Authentication Key
     # CONDUCTOR_AUTH_SECRET: API Auth Secret
     api_config = Configuration()
+    api_config.apply_logging_config()
     task_handler = TaskHandler(configuration=api_config)
     task_handler.start_processes()
 

examples/async/helloworld/helloworld.py

@@ -2,9 +2,9 @@
 
 from greetings_workflow import greetings_workflow
 
+from conductor.asyncio_client.adapters import ApiClient
 from conductor.asyncio_client.automator.task_handler import TaskHandler
 from conductor.asyncio_client.configuration import Configuration
-from conductor.asyncio_client.adapters import ApiClient
 from conductor.asyncio_client.workflow.conductor_workflow import AsyncConductorWorkflow
 from conductor.asyncio_client.workflow.executor.workflow_executor import (
     AsyncWorkflowExecutor,
@@ -22,6 +22,7 @@ async def register_workflow(
 async def main():
     # points to http://localhost:8080/api by default
     api_config = Configuration()
+    api_config.apply_logging_config()
     async with ApiClient(api_config) as api_client:
         workflow_executor = AsyncWorkflowExecutor(
             configuration=api_config, api_client=api_client