Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Menggunakan integrasi layanan tiruan untuk pengujian di Step Functions Local

Di Step Functions Local, Anda dapat menguji jalur eksekusi mesin status Anda tanpa benar-benar memanggil layanan terintegrasi dengan menggunakan integrasi layanan tiruan. Untuk mengonfigurasi mesin status Anda agar menggunakan integrasi layanan tiruan, Anda membuat file konfigurasi tiruan. Dalam file ini, Anda mendefinisikan output yang diinginkan dari integrasi layanan Anda sebagai respons yang diejek dan eksekusi yang menggunakan respons tiruan Anda untuk mensimulasikan jalur eksekusi sebagai kasus uji.

Dengan menyediakan file konfigurasi tiruan ke Step Functions Local, Anda dapat menguji panggilan integrasi layanan dengan menjalankan state machine yang menggunakan respons tiruan yang ditentukan dalam kasus pengujian alih-alih membuat panggilan integrasi layanan yang sebenarnya.

Topik ini menggunakan beberapa konsep yang didefinisikan dalam daftar berikut:

Mengkonfigurasi integrasi layanan yang diejek

Anda dapat mengejek integrasi layanan apa pun menggunakan Step Functions Local. Namun, Step Functions Local tidak memaksakan tiruan menjadi sama dengan aslinya. APIs Tugas yang diejek tidak akan pernah memanggil titik akhir layanan. Jika Anda tidak menentukan respons yang diejek, Tugas akan mencoba memanggil titik akhir layanan. Selain itu, Step Functions Local akan secara otomatis menghasilkan token tugas saat Anda mengejek Task menggunakan. .waitForTaskToken

Langkah 1: Tentukan Integrasi Layanan Mocked dalam File Konfigurasi Mock

Anda dapat menguji Step Functions AWS SDK dan integrasi layanan yang dioptimalkan menggunakan Step Functions Local. Gambar berikut menunjukkan mesin status yang ditentukan dalam tab Definisi mesin Negara:

Untuk melakukan ini, Anda harus membuat file konfigurasi tiruan yang berisi bagian seperti yang didefinisikan dalamStruktur file konfigurasi tiruan.

Langkah 2: Berikan File Konfigurasi Mock ke Step Functions Local

Anda dapat menyediakan file konfigurasi tiruan ke Step Functions Local dengan salah satu cara berikut:

Docker

catatan

Jika Anda menggunakan versi Docker dari Step Functions Local, Anda dapat menyediakan file konfigurasi tiruan hanya menggunakan variabel lingkungan. Selain itu, Anda harus memasang file konfigurasi tiruan ke wadah Step Functions Local pada boot-up server awal.

Pasang file konfigurasi tiruan ke direktori apa pun dalam wadah Step Functions Local. Kemudian, atur variabel lingkungan bernama SFN_MOCK_CONFIG yang berisi path ke file konfigurasi tiruan dalam wadah. Metode ini memungkinkan file konfigurasi tiruan diberi nama apa saja selama variabel lingkungan berisi path file dan nama.

Perintah berikut menunjukkan format untuk memulai image Docker.

docker run -p 8083:8083 
--mount type=bind,readonly,source={absolute path to mock config file},destination=/home/StepFunctionsLocal/MockConfigFile.json 
-e SFN_MOCK_CONFIG="/home/StepFunctionsLocal/MockConfigFile.json" amazon/aws-stepfunctions-local

Contoh berikut menggunakan perintah untuk memulai image Docker.

docker run -p 8083:8083 
--mount type=bind,readonly,source=/Users/admin/Desktop/workplace/MockConfigFile.json,destination=/home/StepFunctionsLocal/MockConfigFile.json 
-e SFN_MOCK_CONFIG="/home/StepFunctionsLocal/MockConfigFile.json" amazon/aws-stepfunctions-local

JAR File

Gunakan salah satu cara berikut untuk menyediakan file konfigurasi tiruan ke Step Functions Local:

• Tempatkan file konfigurasi tiruan di direktori yang sama dengan. Step FunctionsLocal.jar Saat menggunakan metode ini, Anda harus memberi nama file MockConfigFile.json konfigurasi tiruan.

• Dalam sesi yang menjalankan Step Functions LocalSFN_MOCK_CONFIG, atur variabel lingkungan bernama, ke path lengkap file konfigurasi tiruan. Metode ini memungkinkan file konfigurasi tiruan diberi nama apa saja selama variabel lingkungan berisi path file dan nama. Dalam contoh berikut, SFN_MOCK_CONFIG variabel diatur untuk menunjuk pada file konfigurasi tiruan bernamaEnvSpecifiedMockConfig.json, terletak di /home/workspace direktori.

  export SFN_MOCK_CONFIG="/home/workspace/EnvSpecifiedMockConfig.json"

catatan

• Jika Anda tidak menyediakan variabel lingkungan SFN_MOCK_CONFIG ke Step Functions Local, secara default, ia akan mencoba membaca file konfigurasi tiruan bernama MockConfigFile.json dalam direktori tempat Anda meluncurkan Step Functions Local.

• Jika Anda menempatkan file konfigurasi tiruan di direktori yang sama dengan Step FunctionsLocal.jar dan mengatur variabel lingkunganSFN_MOCK_CONFIG, Step Functions Local akan membaca file yang ditentukan oleh variabel lingkungan.

Langkah 3: Jalankan Tes Integrasi Layanan Mocked

Setelah Anda membuat dan menyediakan file konfigurasi tiruan ke Step Functions Local, jalankan state machine yang dikonfigurasi dalam file konfigurasi tiruan menggunakan integrasi layanan tiruan. Kemudian periksa hasil eksekusi menggunakan tindakan API.

File konfigurasi untuk integrasi layanan tiruan di Step Functions

Untuk menggunakan integrasi layanan tiruan, Anda harus terlebih dahulu membuat file konfigurasi tiruan bernama MockConfigFile.json berisi konfigurasi tiruan Anda. Kemudian berikan Step Functions Local dengan file konfigurasi tiruan. File konfigurasi ini mendefinisikan kasus uji, yang berisi status tiruan yang menggunakan respons integrasi layanan tiruan. Bagian berikut berisi informasi tentang struktur konfigurasi tiruan yang mencakup status tiruan dan tanggapan yang diejek:

Struktur file konfigurasi tiruan

Konfigurasi tiruan adalah objek JSON yang berisi bidang tingkat atas berikut:

Berikut ini adalah contoh file konfigurasi tiruan yang mencakup StateMachine definisi danMockedResponse.

{
  "StateMachines":{
    "LambdaSQSIntegration":{
      "TestCases":{
        "HappyPath":{
          "LambdaState":"MockedLambdaSuccess",
          "SQSState":"MockedSQSSuccess"
        },
        "RetryPath":{
          "LambdaState":"MockedLambdaRetry",
          "SQSState":"MockedSQSSuccess"
        },
        "HybridPath":{
          "LambdaState":"MockedLambdaSuccess"
        }
      }
    }
  },
  "MockedResponses":{
    "MockedLambdaSuccess":{
      "0":{
        "Return":{
          "StatusCode":200,
          "Payload":{
            "StatusCode":200,
            "body":"Hello from Lambda!"
          }
        }
      }
    },
    "LambdaMockedResourceNotReady":{
      "0":{
        "Throw":{
          "Error":"Lambda.ResourceNotReadyException",
          "Cause":"Lambda resource is not ready."
        }
      }
    },
    "MockedSQSSuccess":{
      "0":{
        "Return":{
          "MD5OfMessageBody":"3bcb6e8e-7h85-4375-b0bc-1a59812c6e51",
          "MessageId":"3bcb6e8e-8b51-4375-b0bc-1a59812c6e51"
        }
      }
    },
    "MockedLambdaRetry":{
      "0":{
        "Throw":{
          "Error":"Lambda.ResourceNotReadyException",
          "Cause":"Lambda resource is not ready."
        }
      },
      "1-2":{
        "Throw":{
          "Error":"Lambda.TimeoutException",
          "Cause":"Lambda timed out."
        }
      },
      "3":{
        "Return":{
          "StatusCode":200,
          "Payload":{
            "StatusCode":200,
            "body":"Hello from Lambda!"
          }
        }
      }
    }
  }
}

Referensi bidang konfigurasi tiruan

Bagian berikut menjelaskan bidang objek tingkat atas yang harus Anda tentukan dalam konfigurasi tiruan Anda.

StateMachines

StateMachinesObjek mendefinisikan mesin negara mana yang akan menggunakan integrasi layanan tiruan. Konfigurasi untuk setiap mesin negara direpresentasikan sebagai bidang tingkat StateMachines atas. Nama bidang adalah nama mesin negara dan nilai adalah objek yang berisi satu bidang bernamaTestCases, yang bidangnya mewakili kasus uji mesin status tersebut.

Sintaks berikut menunjukkan mesin status dengan dua kasus uji:

"MyStateMachine": {
  "TestCases": {
    "HappyPath": {
      ...
    },
    "SadPath": {
      ...
    }
  }

TestCases

Bidang TestCases mewakili kasus uji individu untuk mesin negara. Nama setiap kasus uji harus unik per mesin negara dan nilai setiap kasus uji adalah objek yang menentukan respons tiruan untuk digunakan untuk status Tugas di mesin status.

Contoh berikut dari TestCase link dua Task negara ke duaMockedResponses:

"HappyPath": {
  "SomeTaskState": "SomeMockedResponse",
  "AnotherTaskState": "AnotherMockedResponse"
}

MockedResponses

MockedResponsesadalah objek yang berisi beberapa objek respons yang diejek dengan nama bidang yang unik. Objek respons yang diejek mendefinisikan hasil yang berhasil atau keluaran kesalahan untuk setiap pemanggilan status Tugas yang diejek. Anda menentukan nomor pemanggilan menggunakan string integer individual, seperti “0", “1", “2", dan “3" atau rentang bilangan bulat inklusif, seperti “0-1", “2-3”.

Saat Anda mengejek Tugas, Anda harus menentukan respons yang diejek untuk setiap pemanggilan. Respons harus berisi satu bidang bernama Return atau Throw yang nilainya adalah hasil atau keluaran kesalahan untuk pemanggilan Tugas yang diejek. Jika Anda tidak menentukan respons yang diejek, eksekusi mesin status akan gagal.

Berikut ini adalah contoh dari MockedResponse dengan Throw dan Return objek. Dalam contoh ini, tiga kali pertama mesin status dijalankan, respons yang "0-2" ditentukan dalam dikembalikan, dan keempat kalinya mesin status berjalan, respons yang "3" ditentukan dalam dikembalikan.

"SomeMockedResponse": {
  "0-2": {
    "Throw": {
      ...
    }
  },
  "3": {
    "Return": {
      ...
    }
  }
}

Nilai yang ditampilkan

Returndirepresentasikan sebagai bidang MockedResponse objek. Ini menentukan hasil sukses dari status Tugas yang diejek.

Berikut ini adalah contoh Return objek yang berisi respons ejekan untuk memanggil Invokefungsi Lambda:

"Return": {
  "StatusCode": 200,
  "Payload": {
    "StatusCode": 200,
    "body": "Hello from Lambda!"
  }
}

Lempar

Throwdirepresentasikan sebagai bidang MockedResponse objek. Ini menentukan output kesalahan dari Tugas gagal. Nilai Throw harus berupa objek yang berisi Error dan Cause bidang dengan nilai string. Selain itu, nilai string yang Anda tentukan di Error bidang di MockConfigFile.json harus cocok dengan kesalahan yang ditangani di Retry dan Catch bagian mesin status Anda.

Berikut ini adalah contoh Throw objek yang berisi respons ejekan untuk memanggil Invokefungsi Lambda:

"Throw": {
  "Error": "Lambda.TimeoutException",
  "Cause": "Lambda timed out."
}