ait_sdk.test package

Submodules

ait_sdk.test.hepler module

class ait_sdk.test.hepler.Helper(backend_entry_point: str, ip_entry_point: str, ait_dir: Path | None = None, ait_full_name: str | None = None, org_name: str = 'dep-a', ml_component_id: str = 1)

Bases: object

テストのヘルパークラスです。

Test helper class.

async_build_ait(zip_path)

aitを非同期でビルドします。

Build ait asynchronously.

Parameters:

zip_path (str) –

zipパスを指定します。

Specifies the zip path.

Returns:

response

deploy_ait_async_and_wait(ait_dir=None, ait_full_name=None, need_build_container: bool = True, wait_time: float = 0.5)

aitを非同期でデプロイします。

Deploy ait asynchronously.

Parameters:

• ait_dir (Path) –

  aitが格納されるフォルダを指定します。

  Specify the folder where the ait is stored.

• ait_full_name (str) –

  aitのバージョンまで含めた完全名を指定します。

  Specify the full name, including the version of ait.

• need_build_container (bool) –

  コンテナビルドが必要かどうかを指定します。

  Specifies whether or not a container build is required.

• wait_time (float) –

  完了チェックの周期秒を指定します。

  Specifies the cycle seconds for completion check.

deploy_ait_non_build(ait_dir=None, ait_full_name=None)

aitをビルド無しでデプロイします。

Deploy ait with no build.

Parameters:

• ait_dir (Path) –

  aitが格納されるフォルダを指定します。

  Specify the folder where the ait is stored.

• ait_full_name (str) –

  aitのバージョンまで含めた完全名を指定します。

  Specify the full name, including the version of ait.

get_bk(path: str, is_print_response: bool = True, is_print_json: bool = True)

バックエンドに対してGETメソッドを発行します。

Issue a GET method to the backend.

Parameters:

• path (str) –

  GETを実行するパスを指定します。

  Specify the path to execute GET.

• is_print_response (bool) –

  レスポンスをprintするか指定します。

  Specifies whether to print the response.

• is_print_json (bool) –

  レスポンスのjsonをprintするか指定します。

  Specifies whether to print the response json.

Returns:

response

get_data_types()

データタイプ一覧を取得します。

Get a list of data types.

Returns:

res_json

get_file_systems()

ファイルシステム一覧を取得します。

Get a list of file systems.

Returns:

res_json

get_inventory(name: str)

インベントリ名を指定して、インベントリJSONを取得します。

Inventory JSON is obtained by specifying an inventory name.

Parameters:

name (str) –

インベントリ名前を指定します。

Specify an inventory name.

Returns:

res_json

get_ip(path: str, is_print_response: bool = True, is_print_json: bool = True)

IPに対してGETメソッドを発行します。

Issue a GET method to the IP.

Parameters:

• path (str) –

  GETを実行するパスを指定します。

  Specify the path to execute GET.

• is_print_response (bool) –

  レスポンスをprintするか指定します。

  Specifies whether to print the response.

• is_print_json (bool) –

  レスポンスのjsonをprintするか指定します。

  Specifies whether to print the response json.

Returns:

response

get_td(name: str)

テストデスクリプション名を指定して、テストデスクリプションJSONを取得します。

Get the test-description JSON by specifying the test-description name.

Parameters:

name (str) –

テストデスクリプション名前を指定します。

Specify a test-description name.

Returns:

res_json

get_td_detail(td_id: int)

テストデスクリプション名を指定して、テストデスクリプション詳細JSONを取得します。

Get the test-description detail JSON by specifying the test-description name.

Parameters:

td_id –

テストデスクリプションIDを指定します。

Specifies the test-description ID.

Returns:

res_json

post_bk(path: str, data, is_print_response: bool = True, is_print_json: bool = True)

バックエンドに対してPOSTメソッドを発行します。

Issue a POST method to the backend.

Parameters:

• path (str) –

  GETを実行するパスを指定します。

  Specify the path to execute GET.

• data –

  POSTするデータを指定します。

  Specify the data to be POSTed.

• is_print_response (bool) –

  レスポンスをprintするか指定します。

  Specifies whether to print the response.

• is_print_json (bool) –

  レスポンスのjsonをprintするか指定します。

  Specifies whether to print the response json.

Returns:

response

post_inventory(name: str, type_id: int, file_system_id: int, file_pass: str, description: str, formats: []) → str

インベントリのPOSTメソッドを発行します。

Issue a POST method for inventory.

Parameters:

• name (str) –

  名前を指定します。

  Specify a name.

• type_id –

  タイプIDを指定します。

  Specify the type ID.

• file_system_id –

  ファイルシステムIDをprintするか指定します。

  Specifies whether to print the file system ID.

• file_pass (str) –

  ファイルパスを指定します。

  Specifies the file path.

• description (str) –

  説明を指定します。

  Specify a description.

• formats –

  フォーマットを指定します。

  Specify the format.

Returns:

inventory_name

post_ip(path: str, data, is_print_response: bool = True, is_print_json: bool = True)

IPに対してPOSTメソッドを発行します。

Issue a POST method to the IP.

Parameters:

• path (str) –

  GETを実行するパスを指定します。

  Specify the path to execute GET.

• data –

  POSTするデータを指定します。

  Specify the data to be POSTed.

• is_print_response (bool) –

  レスポンスをprintするか指定します。

  Specifies whether to print the response.

• is_print_json (bool) –

  レスポンスのjsonをprintするか指定します。

  Specifies whether to print the response json.

Returns:

response

post_manifest(manifest_path)

ait.manifest.jsonをバックエンドに登録します。

Register ait.manifest.json in the backend.

Parameters:

manifest_path (str) –

ait.manifest.jsonパスを指定します。

Specifies the ait.manifest.json path.

Returns:

response

post_ml_component(name: str, description: str, problem_domain: str, ml_framework_id: int = -1, guideline_id: int = -1, scope_id: int = -1)

MLコンポーネントのPOSTメソッドを発行します。

Issue the POST method of ML components.

Parameters:

• name (str) –

  名前を指定します。

  Specify a name.

• description –

  説明を指定します。

  Specify a description.

• problem_domain –

  問題領域を指定します。

  Specify the problem domain.

• ml_framework_id –

  MLフレームワークIDを指定します。

  Specify the ML framework ID.

• guideline_id –

  ガイドラインIDを指定します。

  Specify the ML guideline ID.

• scope_id –

  スコープIDを指定します。

  Specify the scope ID.

Returns:

res_json

post_report(*td_id)

指定したテストデスクリプションIDでレポートを生成します。

Generate a report with the specified test-description ID.

Parameters:

td_id –

テストデスクリプションIDを指定します。

Specifies the test-description ID.

Returns:

res_json

post_run_and_wait(*td_id)

指定したテストデスクリプションIDを実行して、完了するまで待機します。

Run the specified Test Description ID and wait for it to complete.

Parameters:

td_id –

テストデスクリプションIDを指定します。

Specifies the test-description ID.

post_td(name: str, quality_dimension_id: id, quality_measurements, target_inventories, test_runner)

テストデスクリプションのPOSTメソッドを発行します。

Issue the POST method of the test-description.

Parameters:

• name (str) –

  名前を指定します。

  Specify a name.

• quality_dimension_id –

  品質ディメンションIDを指定します。

  Specifies a quality dimension ID.

• quality_measurements –

  品質指標を指定します。

  Specify a quality quality_measurements.

• target_inventories –

  対象インベントリを指定します。

  Specify the target inventory.

• test_runner –

  テストランナーを指定します。

  Specify a test runner.

set_ml_component_id(ml_component_id: int)

MLコンポーネントIDを設定します。

Set the ML component ID.

Parameters:

ml_component_id (int) –

MLコンポーネントIDを指定します。

Specify the ML component ID.

upload_zip_id(zip_path: str)

zipファイルをアップロードします。 これはAITをデプロイするために使用します。

Upload the zip file. This will be used to deploy the AIT.

Parameters:

zip_path (str) –

zipパスを指定します。

Specifies the zip path.

Returns:

response

Module contents