feat: Add Client for Systems State Service APIs #89
Conversation
shri2k2
requested review from
mure,
spanglerco and
cameronwaterman
as code owners
| Overview | ||
| ~~~~~~~~ | ||
|
|
||
| The :class:`.SystemsStateClient` class is the primary entry point of the Product API. |
There was a problem hiding this comment.
| The :class:`.SystemsStateClient` class is the primary entry point of the Product API. | |
| The :class:`.SystemsStateClient` class is the primary entry point of the Systems State API. |
| # prevent pytest from thinking this is a test class | ||
| __test__ = False |
There was a problem hiding this comment.
| # prevent pytest from thinking this is a test class | |
| __test__ = False |
Not relevant as the class name does not start with Test
| architecture: Optional[models.Architecture] = None, | ||
| distribution: Optional[models.Distribution] = None, |
There was a problem hiding this comment.
Enum is not supported by Uplink and hence create a wrapper method to take care of Enum to str conversion.
Reference -
| ... | ||
|
|
||
| @post("states", args=[Body]) | ||
| def create_state(self, new_state: models.StateRequest) -> models.StateResponse: |
There was a problem hiding this comment.
| def create_state(self, new_state: models.StateRequest) -> models.StateResponse: | |
| def create_state(self, state: models.StateRequest) -> models.StateResponse: |
| ... | ||
|
|
||
| @post("export-state", args=[Body]) | ||
| def export_state(self, export_state_request: models.ExportStateRequest) -> str: |
There was a problem hiding this comment.
| def export_state(self, export_state_request: models.ExportStateRequest) -> str: | |
| def export_state(self, query: models.ExportStateRequest) -> str: |
| Part(name="File", type=str), | ||
| ], | ||
| ) | ||
| def import_state( |
There was a problem hiding this comment.
Since there are models.Architecture and models.Distribution, use the same as inputs for this method as well, do handle the enum to str conversion using the wrapper function
| ... | ||
|
|
||
| @post("delete-states", args=[Body]) | ||
| def delete_states(self, states_id_list: List[str]) -> None: |
There was a problem hiding this comment.
| def delete_states(self, states_id_list: List[str]) -> None: | |
| def delete_states(self, ids: List[str]) -> None: |
| id: Optional[str] = None | ||
| """Gets or sets the ID of the state.""" | ||
|
|
||
| createdTimestamp: datetime |
There was a problem hiding this comment.
For all model fields, use snake_case and let the JsonModel convert it to camelCase at runtime serialization.
| createdTimestamp: datetime | |
| created_timestamp: datetime |
camelCase serialization defined at
| feeds: Optional[List[Feed]] = None | ||
| """List of all feeds associated with the particular state""" | ||
|
|
||
| systemImage: SystemImage |
There was a problem hiding this comment.
make Pythonic
| systemImage: SystemImage | |
| system_image: SystemImage |
| @pytest.fixture | ||
| def default_work_space() -> str: | ||
| """Fixture that returns the default workspace id""" | ||
| return "846e294a-a007-47ac-9fc2-fac07eab240e" |
There was a problem hiding this comment.
Tests should be agnostic of the SLE instance and equipped to work with a fresh deployment by taking care of creating/deleting any necessary entities or mock them in the requests response.
| return "846e294a-a007-47ac-9fc2-fac07eab240e" | |
| return "" |
What does this Pull Request accomplish?
This PR adds API Client Module for
Statesmicroservice in theSystems State Service.Why should this Pull Request be merged?
The
SystemsStateClientmakes it easier for users to interact with the endpoints ofSystems State Serviceby just creating an instance of it.What testing has been done?
Automated integration tests are included.
API Link: Swagger Link