tests for simulation and file transfer + upgrade ansys-optics-speos-grpcapi + precise version of docker image (#51)

* Add tests for simulation and file transfer + upgrade ansys-optics-speos-grpcapi + precise version of docker image

* use new version of docker image ghcr.io/pyansys/pyoptics/speos-rpc:2022.2.0.235

* fix test

* fix test

Author: echambla

docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3.4"
 services:
   pyoptics_speos-rpc:
-    image: ghcr.io/pyansys/pyoptics/speos-rpc
+    image: ghcr.io/pyansys/pyoptics/speos-rpc:2022.2.0.235
     container_name: pyoptics_speos-rpc
     ports:
       - "50051:50051"

pyproject.toml

@@ -23,7 +23,7 @@ classifiers=[
     "Operating System :: OS Independent",
 ]
 dependencies=[
-    "ansys-optics-speos-grpcapi==5.0.0",
+    "ansys-optics-speos-grpcapi==6.0.0",
     "grpcio-tools==1.48.1",
 ]
 

requirements/requirements_build.txt

@@ -1,4 +1,4 @@
 build==0.8.0
 twine==4.0.1
-ansys-optics-speos-grpcapi==5.0.0
+ansys-optics-speos-grpcapi==6.0.0
 grpcio-tools==1.48.1

tests/test_lpf_file_reader.py

@@ -22,7 +22,7 @@
 from conftest import config, local_test_path, test_path
 
 
-def test_lpf_file_reader_mono_v1_DirectSimu():
+def test_lpf_file_reader_mono_v2_DirectSimu():
     # Lpf file reader creation
     stub = grpc_stub.get_stub_insecure_channel(
         target="localhost:" + str(config.get("SpeosServerPort")),
@@ -73,7 +73,7 @@ def test_lpf_file_reader_mono_v1_DirectSimu():
     stub.CloseLpfFileName(lpf_file_reader__v2__pb2.CloseLpfFileName_Request_Mono())
 
 
-def test_lpf_file_reader_mono_v1_InverseSimu():
+def test_lpf_file_reader_mono_v2_InverseSimu():
     # Lpf file reader creation
     stub = grpc_stub.get_stub_insecure_channel(
         target="localhost:" + str(config.get("SpeosServerPort")),
@@ -110,7 +110,7 @@ def test_lpf_file_reader_mono_v1_InverseSimu():
     stub.CloseLpfFileName(lpf_file_reader__v2__pb2.CloseLpfFileName_Request_Mono())
 
 
-def test_lpf_file_reader_multi_v1():
+def test_lpf_file_reader_multi_v2():
     # Lpf file reader multi creation
     stub = grpc_stub.get_stub_insecure_channel(
         target="localhost:" + str(config.get("SpeosServerPort")),
@@ -181,7 +181,7 @@ def test_lpf_file_reader_multi_v1():
     stub.Delete(lpf_file_reader__v2__pb2.Delete_Request_Multi(lpf_reader_guid=guid))
 
 
-def test_lpf_file_reader_mono_v1_DirectSimu_with_upload():
+def test_lpf_file_reader_mono_v2_DirectSimu_with_file_transfer():
     # local file upload to the server
     path = os.path.join(local_test_path, "basic_DirectSimu.lpf")
     file_transfer_stub = grpc_stub.get_stub_insecure_channel(
@@ -197,7 +197,7 @@ def test_lpf_file_reader_mono_v1_DirectSimu_with_upload():
     )
 
     # Init with uri from file transfer
-    stub.InitLpfFileName(lpf_file_reader__v2__pb2.InitLpfFileName_Request_Mono(lpf_file_uri=upload_response.uri))
+    stub.InitLpfFileName(lpf_file_reader__v2__pb2.InitLpfFileName_Request_Mono(lpf_file_uri=upload_response.info.uri))
 
     # GetInformation
     res_information = stub.GetInformation(lpf_file_reader__v2__pb2.GetInformation_Request_Mono())
@@ -239,4 +239,4 @@ def test_lpf_file_reader_mono_v1_DirectSimu_with_upload():
     stub.CloseLpfFileName(lpf_file_reader__v2__pb2.CloseLpfFileName_Request_Mono())
 
     # Delete the file previously uploaded to the server - it is no more needed
-    file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=upload_response.uri))
+    file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=upload_response.info.uri))

tests/test_simulation.py

@@ -11,12 +11,16 @@
 
 """
 import os
+import shutil
 
 from ansys.api.speos import grpc_stub
+from ansys.api.speos.file.v1 import file_transfer
+import ansys.api.speos.file.v1.file_transfer_pb2 as file_transfer__v1__pb2
+import ansys.api.speos.file.v1.file_transfer_pb2_grpc as file_transfer__v1__pb2_grpc
 import ansys.api.speos.simulation.v1.simulation_pb2 as simulation__v1__pb2
 import ansys.api.speos.simulation.v1.simulation_pb2_grpc as simulation__v1__pb2_grpc
 
-from conftest import config, test_path
+from conftest import config, local_test_path, test_path
 from helper import does_file_exist, remove_file
 
 
@@ -74,3 +78,112 @@ def test_simulation():
     delete_request = simulation__v1__pb2.Delete_Request()
     delete_request.guid = guid_simu.guid
     simulation_manager_stub.Delete(delete_request)
+
+
+def test_simu_allocateSyst_load_run_with_file_transfer():
+    # Stubs creations
+    file_transfer_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=file_transfer__v1__pb2_grpc.FileTransferServiceStub,
+    )
+    simu_manager_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=simulation__v1__pb2_grpc.SpeosSimulationsManagerStub,
+    )
+    simu_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=simulation__v1__pb2_grpc.SpeosSimulationStub,
+    )
+
+    # Use upload_folder helper provided within ansys.api.speos.file.v1
+    sv5_name = "LG_50M_Colorimetric_short.sv5"
+    upload_responses = file_transfer.upload_folder(
+        file_transfer_service_stub=file_transfer_stub,
+        folder_path=os.path.join(local_test_path, sv5_name),
+        main_file_name=sv5_name,
+    )
+    sv5_res_uri = [upload_res.info.uri for upload_res in upload_responses if upload_res.info.file_name == sv5_name][0]
+
+    # Allocate system
+    create_res = simu_manager_stub.Create(simulation__v1__pb2.Create_Request())
+
+    # Load sv5 into allocated system
+    simu_stub.Load(simulation__v1__pb2.Load_Request(guid=create_res.guid, input_file_path=sv5_res_uri))
+
+    # Run
+    run_res = simu_stub.Run(simulation__v1__pb2.Run_Request(guid=create_res.guid))
+    assert len(run_res.result_upload_responses) == 2
+    assert run_res.result_upload_responses[0].info.file_name == "ASSEMBLY1.DS (0).Dom Irradiance Sensor (0).xmp"
+    assert run_res.result_upload_responses[1].info.file_name == "ASSEMBLY1.DS (0).html"
+
+    # Delete files on Server
+    # Files uploaded
+    file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=sv5_res_uri))
+    # Results from simu
+    for res_uploaded in run_res.result_upload_responses:
+        file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=res_uploaded.info.uri))
+
+
+def test_simu_allocateSyst_load_save_with_file_transfer():
+    # Stubs creations
+    file_transfer_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=file_transfer__v1__pb2_grpc.FileTransferServiceStub,
+    )
+    simu_manager_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=simulation__v1__pb2_grpc.SpeosSimulationsManagerStub,
+    )
+    simu_stub = grpc_stub.get_stub_insecure_channel(
+        target="localhost:50051",
+        stub_type=simulation__v1__pb2_grpc.SpeosSimulationStub,
+    )
+    sv5_name = "LG_50M_Colorimetric_short.sv5"
+    blue_spectrum = "Blue Spectrum.spectrum"
+    red_spectrum = "Red Spectrum.spectrum"
+
+    # Use upload_folder helper provided within ansys.api.speos.file.v1
+    upload_responses = file_transfer.upload_folder(
+        file_transfer_service_stub=file_transfer_stub,
+        folder_path=os.path.join(local_test_path, sv5_name),
+        main_file_name=sv5_name,
+    )
+    sv5_res_uri = [upload_res.info.uri for upload_res in upload_responses if upload_res.info.file_name == sv5_name][0]
+
+    # Allocate system
+    create_res = simu_manager_stub.Create(simulation__v1__pb2.Create_Request())
+
+    # Load sv5 into allocated system
+    simu_stub.Load(simulation__v1__pb2.Load_Request(guid=create_res.guid, input_file_path=sv5_res_uri))
+
+    # Reserve an item in file system in order to perform a Save
+    reserve_res = file_transfer_stub.Reserve(file_transfer__v1__pb2.Reserve_Request())
+    # And Save
+    simu_stub.Save(simulation__v1__pb2.Save_Request(guid=create_res.guid, input_folder_path=reserve_res.uri))
+
+    # We can then list dependencies of the reserved item to check that it contains two deps with correct names
+    deps_response = file_transfer_stub.ListDependencies(
+        file_transfer__v1__pb2.ListDependencies_Request(uri=reserve_res.uri)
+    )
+    assert len(deps_response.dependency_infos) == 2
+    assert [dep_info for dep_info in deps_response.dependency_infos if dep_info.file_name == blue_spectrum]
+    assert [dep_info for dep_info in deps_response.dependency_infos if dep_info.file_name == red_spectrum]
+
+    # And download locally the simu saved - using download_folder helper provided within ansys.api.speos.file.v1
+    download_loc = os.path.join(local_test_path, "download_simu")
+    os.mkdir(download_loc)
+    download_responses = file_transfer.download_folder(
+        file_transfer_service_stub=file_transfer_stub, main_file_uri=reserve_res.uri, download_location=download_loc
+    )
+    # Check that file are well downloaded
+    for res in download_responses:
+        downloaded_file = os.path.join(download_loc, res.info.file_name)
+        assert os.path.exists(downloaded_file)
+        assert os.path.getsize(downloaded_file) == res.info.file_size
+    shutil.rmtree(download_loc)
+
+    # Delete files on Server
+    # Files uploaded
+    file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=sv5_res_uri))
+    # Files saved
+    file_transfer_stub.Delete(file_transfer__v1__pb2.Delete_Request(uri=reserve_res.uri))