Add V1 endpoints for factory, machine, machine_type #24

mks-sight · 2022-12-06T05:34:07Z

Hi, Please review the PR, Thanks

https://sightmachine.atlassian.net/browse/MARS-7090

…e method to use v1 endpints defined

…ine and get_machine_type

… log error inplace of print

…get_factory

smsdk/client.py

smsdk/client_v0.py

smsdk/ma_session.py

smsdk/smsdk_entities/factory/factoryV1.py

smsdk/smsdk_entities/machine_type/machinetypeV1.py

… auth_check

mklein0

Could unit tests against https://demo-continuous.sightmachine.io/ be added? I think we can have basic username/password added to that tenant. We wouild just need to add the password for our list of secrets in repo, so if it needs to be changed we are aware of it.

smsdk/client.py

smsdk/utils.py

mklein0 · 2023-02-08T17:14:26Z

A test using mocks against the requests library can be done with: https://requests-mock.readthedocs.io/en/latest/mocker.html

…er_by with select and order_by, priorities with single char

mks-sight · 2023-02-13T14:16:50Z

A test using mocks against the requests library can be done with: https://requests-mock.readthedocs.io/en/latest/mocker.html

Are we looking for new way of mocking request since monkeypatch of mock is already there or we are looking for an INTEGRATION test to test sdk code end to end

for eg.

`def test_get_machines(monkeypatch):
# Setup
def mockapi(self, session, endpoint):
if endpoint == "/api/machine":
return pd.DataFrame(JSON_MACHINE)
return pd.DataFrame()

monkeypatch.setattr(Machine, "get_machines", mockapi)

dt = Machine(Session(), "demo")

# Run
df = dt.get_machines(Session(), "/api/machine")

# Verify
assert df.shape == (27, 7)

cols = [
    "factory_location",
    "factory_partner",
    "id",
    "metadata",
    "source",
    "source_clean",
    "source_type",
]

assert cols == df.columns.sort_values().tolist()

`

in this code we are mocking, do we need to add more tests like this or do we need to use the sdk to test against demo-continuos from an end-user perspective?
Thanks

smsdk/client_v0.py

smsdk/config/api_endpoints.json

smsdk/ma_session.py

smsdk/utils.py

… the way exceptions were logged, add data type for check_kw, removed v0 endpoints

mks-sight · 2023-03-27T06:11:27Z

A test using mocks against the requests library can be done with: https://requests-mock.readthedocs.io/en/latest/mocker.html

we are creating a separate ticket for this

mks-sight · 2023-03-27T06:12:06Z

A test using mocks against the requests library can be done with: https://requests-mock.readthedocs.io/en/latest/mocker.html

we are creating a separate ticket for this

mks-sight · 2023-03-27T06:12:32Z

Could unit tests against https://demo-continuous.sightmachine.io/ be added? I think we can have basic username/password added to that tenant. We wouild just need to add the password for our list of secrets in repo, so if it needs to be changed we are aware of it.

we are creating a separate ticket for this

…eplace

smsdk/Auth/auth.py

smsdk/utils.py

mklein0 · 2023-03-29T05:13:57Z

smsdk/client.py

+                if util_name in ['get_factories', 'get_machines', 'get_machine_types']:
+                    # data = dict_to_df(getattr(cls, util_name)(*args, **sub_kwargs[0]), normalize)
+                    return getattr(cls, util_name)(normalize, *args, **sub_kwargs[0])


FYI, It it the way the current SDK is designed, but I dislike the need to need to inspect the method names to determine function signatures rather than leveraging the language and OO methods.

mklein0 · 2023-03-29T05:15:48Z

smsdk/client.py

@@ -157,13 +160,17 @@ def get_data_v1(self, ename, util_name, normalize=True, *args, **kwargs):
            # dict params strictly follow {'key':'value'} format

            # sub_kwargs = kwargs
-            if util_name in ['get_cycles', 'get_downtime', 'get_parts']:
+            if util_name in ['get_cycles', 'get_downtime', 'get_parts', 'get_factories', 'get_machines', 'get_machine_types']:


Unit Tests are a separate PR?

A useful combination of tools to see how well the code created has test coverage is:

coverage

diff-cover

ex.

coverage run -m pytest -vvv -s tests coverage xml diff-cover --compare-branch origin/master --html-report diff-report.html coverage.xml xdg-open diff-report.html

The report given goes off the code vs the diff, but still useful.

smsdk/client.py

…o mars-7090-test

harshmishraintg · 2023-06-06T04:41:07Z

I don't have any more comments on this. Approved

mgoldmansight · 2023-07-25T20:43:18Z

smsdk/smsdk_entities/machine/machineV1.py

+        #     raise ValueError("Error - {}".format(records))
+        return records
+
+    def modify_input_params(self, **kwargs):


I might be missing something but it seems like all of these modify_input_params are the same. Is there a reason this isn't a util you import?

mklein0 · 2023-07-25T20:16:24Z

smsdk/ma_session.py

@@ -278,3 +277,87 @@ def get_starttime_endtime_keys(self, **kwargs):
                    continue

        return starttime_key, endtime_key
+
+    def _get_records_mongo_v1(


What does mongo in the function name mean?

mklein0 · 2023-07-25T20:25:35Z

smsdk/client_v0.py

What is this module kept around for? What v0 interfaces remain?

comment get_cycles, get_parts, get_downtimes methods for ClientV0 bas…

ae370cd

…e method to use v1 endpints defined

mks-sight assigned kunalagrawalintg Dec 6, 2022

Mohan Sahu added 9 commits December 7, 2022 20:56

add v1 endpoint for get_factory and get_machine, need to fix get_mach…

259faf1

…ine and get_machine_type

add v1 endpoint for factory and machine, need to fix arg passing issue

45288ca

add v1 endpoint for factory

e1e36f9

add get_machines, get_machine_types

fa4c575

add v1 endpoint for get_machine_names and get_machine_type_names

e685cf4

add check_kw, remove explicit None, add return type for get_machines,…

daf5261

… log error inplace of print

fix limit and offset args to work with changes, return generator for …

65a7b8f

…get_factory

add wraper around get_factory, get_machine and get_machine_types method

99cb7b8

removed unwanted code

9fec588