Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise validation strategy for conformance of API and CLI #342

Open
ckunki opened this issue Jun 7, 2023 · 0 comments
Open

Revise validation strategy for conformance of API and CLI #342

ckunki opened this issue Jun 7, 2023 · 0 comments
Labels
refactoring Code improvement without behavior change

Comments

@ckunki
Copy link
Contributor

ckunki commented Jun 7, 2023

Currently ITDE contains automated tests verifying the compatibility of API and CLI.
However the current approach creates some problems.

Problem1: There are two API branches, while only the second one is verified.

lib/api/spawn_test_environment_with_test_container.py

@no_cli_function
def spawn_test_environment_with_test_container(

lib/api/spawn_test_environment:

@cli_function
def spawn_test_environment()

Problem 2: Is 100% identical interface really desired or required?

Potential situations uncovered by the current approach:

  • API could offer more functionality than what should be accessible via CLI
  • API may benefit for more sophisticated data types, e.g. PortForwarding rather than only basic types such as str and int than can be supplied via CLI.
@ckunki ckunki added the refactoring Code improvement without behavior change label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Code improvement without behavior change
Projects
None yet
Development

No branches or pull requests

1 participant