Mengonfigurasi pengaturan untuk test runner - AWS IoT Greengrass
Konfigurasikan device.json(Opsional) Konfigurasikan userdata.json(Opsional) Konfigurasikan resource.json(Opsional) Konfigurasikan config.json

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

Mengonfigurasi pengaturan untuk test runner

Untuk menjalankan rangkaian tes kustom, test runner harus mengonfigurasi pengaturannya berdasarkan rangkaia tes yang ingin dijalankannya. Pengaturan ditentukan berdasarkan templat file konfigurasi yang terletak di <device-tester-extract-location>/configs/ folder. Jika diperlukan, test runner juga harus mengatur kredensial AWS yang akan digunakan oleh IDT untuk terhubung ke cloud AWS.

Sebagai penyusun tes, Anda perlu mengonfigurasi file-file ini untuk men-debug rangkaian tes. Anda harus memberikan petunjuk kepada test runner agar dapat mengonfigurasi pengaturan berikut yang diperlukan untuk menjalankan rangkaian tes Anda.

Konfigurasikan device.json

File device.json berisi informasi tentang perangkat tempat uji dijalankan (misalnya, alamat IP, informasi login, sistem operasi, dan arsitektur CPU).

Test runner dapat memberikan informasi ini dengan menggunakan file device.json templat berikut yang terletak di folder <device-tester-extract-location>/configs/.

[
    {
        "id": "<pool-id>",
        "sku": "<pool-sku>",
        "features": [
            {
                "name": "<feature-name>",             
                "value": "<feature-value>",                
                "configs": [
                    {
                        "name": "<config-name>",                    
                        "value": "<config-value>"
                    }
                ],
            }
        ],     
        "devices": [
            {
                "id": "<device-id>",              
                "connectivity": {
                    "protocol": "ssh | uart | docker",                   
                    // ssh
                    "ip": "<ip-address>",
                    "port": <port-number>,
                    "auth": {
                        "method": "pki | password",
                        "credentials": {
                            "user": "<user-name>", 
                            // pki
                            "privKeyPath": "/path/to/private/key",
                                         
                            // password
                            "password": "<password>",
                        }
                    },
                    
                    // uart
                    "serialPort": "<serial-port>",
                    
                    // docker
                    "containerId": "<container-id>",
                    "containerUser": "<container-user-name>",
                }
            }
        ]
    }
]

Semua kolom yang berisi nilai wajib diisi seperti yang dijelaskan di sini:

id

ID alfanumerik yang ditetapkan pengguna secara unik mengidentifikasi kumpulan perangkat yang disebut kolam perangkat. Perangkat yang termasuk dalam suatu kolam harus memiliki perangkat keras yang identik. Ketika Anda menjalankan serangkaian tes, perangkat di kolam tersebut digunakan untuk memparalelkan beban kerja. Beberapa perangkat digunakan untuk menjalankan tes yang berbeda.

sku

Nilai alfanumerik secara unik mengidentifikasi perangkat yang sedang diuji. SKU digunakan untuk melacak perangkat yang berkualitas.

catatan

Jika Anda ingin mencantumkan forum Anda di Katalog perangkat AWS Partner, SKU yang Anda tentukan di sini harus sesuai dengan SKU yang Anda gunakan dalam proses pencantuman itu.

features

Opsional. Rangkaian yang berisi fitur perangkat yang didukung. Fitur perangkat adalah nilai-nilai yang ditetapkan pengguna yang Anda konfigurasikan di rangkaian tes Anda. Anda harus memberikan informasi kepada test runner tentang nama fitur dan nilai-nilai yang akan disertakan dalam file device.json. Misalnya, jika Anda ingin menguji perangkat yang berfungsi sebagai server MQTT untuk perangkat lain, maka Anda dapat mengonfigurasi logika uji Anda untuk memvalidasi tingkat tertentu yang didukung untuk fitur bernama MQTT_QOS. Test runner memberikan nama fitur ini dan menetapkan nilai fitur ke tingkat QOS yang didukung oleh perangkatnya. Anda dapat mengambil informasi yang disediakan dari konteks IDT dengan devicePool.features kueri, atau dari konteks orkestrator pengujian dengan kueri. pool.features

features.name

Nama fitur.

features.value

Nilai fitur yang didukung.

features.configs

Pengaturan konfigurasi, jika diperlukan, untuk fitur.

features.config.name

Nama pengaturan konfigurasi.

features.config.value

Nilai pengaturan yang didukung.

devices

Rangkaian perangkat di kolam yang akan diuji. Setidaknya diperlukan satu perangkat.

devices.id

Pengenal unik yang ditetapkan pengguna untuk perangkat yang sedang diuji.

connectivity.protocol

Protokol komunikasi yang digunakan untuk berkomunikasi dengan perangkat ini. Setiap perangkat di kolam harus menggunakan protokol yang sama.

Saat ini, satu-satunya nilai yang didukung adalah ssh dan uart untuk perangkat fisik, dan docker untuk kontainer Docker.

connectivity.ip

Alamat IP perangkat yang sedang diuji.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.port

Opsional. Jumlah port yang akan digunakan untuk koneksi SSH.

Nilai default-nya adalah 22.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.auth

Informasi autentikasi untuk koneksi tersebut.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.auth.method

Metode autentikasi yang digunakan untuk mengakses perangkat melalui protokol konektivitas yang diberikan.

Nilai yang didukung adalah:

  • pki

  • password

connectivity.auth.credentials

Kredensial yang digunakan untuk autentikasi.

connectivity.auth.credentials.password

Kata sandi yang digunakan untuk masuk ke perangkat yang sedang diuji.

Nilai ini hanya berlaku jika connectivity.auth.method diatur ke password.

connectivity.auth.credentials.privKeyPath

Jalur lengkap ke kunci privat yang digunakan untuk masuk ke perangkat yang sedang diuji.

Nilai ini hanya berlaku jika connectivity.auth.method diatur ke pki.

connectivity.auth.credentials.user

Nama pengguna untuk masuk ke perangkat yang sedang diuji.

connectivity.serialPort

Opsional. Port serial tempat perangkat itu terhubung.

Properti ini hanya berlaku jika connectivity.protocol diatur ke uart.

connectivity.containerId

ID kontainer atau nama kontainer Docker yang sedang diuji.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.containerUser

Opsional. Nama pengguna untuk pengguna di dalam kontainer. Nilai default adalah pengguna yang disediakan di Dockerfile.

Nilai default-nya adalah 22.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

catatan

Untuk memeriksa apakah pelari pengujian mengonfigurasi koneksi perangkat yang salah untuk pengujian, Anda dapat mengambil pool.Devices[0].Connectivity.Protocol dari konteks orkestrator pengujian dan membandingkannya dengan nilai yang diharapkan dalam status. Choice Jika protokol yang salah digunakan, cetak pesan dengan menggunakan keadaan LogMessage dan beralihlah ke keadaan Fail.

Atau, Anda dapat menggunakan kode penanganan kesalahan untuk melaporkan kegagalan pengujian untuk jenis perangkat yang salah.

(Opsional) Konfigurasikan userdata.json

File userdata.json berisi informasi tambahan yang diperlukan oleh rangkaian tes tetapi tidak ditentukan dalam file device.json. Format file ini tergantung pada file userdata_scheme.json yang ditentukan dalam rangkaian uji tersebut. Jika Anda seorang penyusun tes, pastikan Anda memberikan informasi ini kepada pengguna yang akan menjalankan rangkaian tes yang Anda susun.

(Opsional) Konfigurasikan resource.json

File resource.json berisi informasi tentang perangkat apa pun yang akan digunakan sebagai perangkat sumber daya. Perangkat sumber daya adalah perangkat yang diperlukan untuk menguji kemampuan tertentu dari perangkat yang diuji. Misalnya, untuk menguji kemampuan Bluetooth perangkat, Anda mungkin menggunakan perangkat sumber daya untuk menguji apakah perangkat Anda dapat berhasil tersambung. Perangkat sumber daya bersifat opsional, dan Anda dapat memerlukan perangkat sumber daya sebanyak yang Anda butuhkan. Sebagai penyusun tes, Anda menggunakan file test.json untuk menentukan fitur perangkat sumber daya yang diperlukan untuk tes. Test runner kemudian akan menggunakan file resource.json untuk menyediakan kolam perangkat sumber daya yang memiliki fitur yang diperlukan. Pastikan Anda memberikan informasi ini kepada pengguna yang akan menjalankan rangkaian tes yang Anda tulis.

Test runner dapat memberikan informasi ini dengan menggunakan file resource.json templat berikut yang terletak di folder <device-tester-extract-location>/configs/.

[
    {
        "id": "<pool-id>",
        "features": [
            {
                "name": "<feature-name>",             
                "version": "<feature-version>",                
                "jobSlots": <job-slots>
            }
        ],     
        "devices": [
            {
                "id": "<device-id>",              
                "connectivity": {
                    "protocol": "ssh | uart | docker",                   
                    // ssh
                    "ip": "<ip-address>",
                    "port": <port-number>,
                    "auth": {
                        "method": "pki | password",
                        "credentials": {
                            "user": "<user-name>", 
                            // pki
                            "privKeyPath": "/path/to/private/key",
                                         
                            // password
                            "password": "<password>",
                        }
                    },
                    
                    // uart
                    "serialPort": "<serial-port>",
                    
                    // docker
                    "containerId": "<container-id>",
                    "containerUser": "<container-user-name>",
                }
            }
        ]
    }
]

Semua kolom yang berisi nilai wajib diisi seperti yang dijelaskan di sini:

id

ID alfanumerik yang ditetapkan pengguna secara unik mengidentifikasi kumpulan perangkat yang disebut kolam perangkat. Perangkat yang termasuk dalam suatu kolam harus memiliki perangkat keras yang identik. Ketika Anda menjalankan serangkaian tes, perangkat di kolam tersebut digunakan untuk memparalelkan beban kerja. Beberapa perangkat digunakan untuk menjalankan tes yang berbeda.

features

Opsional. Rangkaian yang berisi fitur perangkat yang didukung. Informasi yang diperlukan dalam kolom ini ditentukan dalam file test.json di rangkaian tes dan menentukan tes mana yang akan dijalankan dan bagaimana menjalankan tes tersebut. Jika rangkaian tes tidak memerlukan fitur apa pun, kolom ini tidak wajib diisi.

features.name

Nama fitur.

features.version

Versi fitur.

features.jobSlots

Pengaturan untuk menunjukkan berapa banyak tes yang dapat secara bersamaan menggunakan perangkat. Nilai default-nya adalah 1.

devices

Rangkaian perangkat di kolam yang akan diuji. Setidaknya diperlukan satu perangkat.

devices.id

Pengenal unik yang ditetapkan pengguna untuk perangkat yang sedang diuji.

connectivity.protocol

Protokol komunikasi yang digunakan untuk berkomunikasi dengan perangkat ini. Setiap perangkat di kolam harus menggunakan protokol yang sama.

Saat ini, satu-satunya nilai yang didukung adalah ssh dan uart untuk perangkat fisik, dan docker untuk kontainer Docker.

connectivity.ip

Alamat IP perangkat yang sedang diuji.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.port

Opsional. Jumlah port yang akan digunakan untuk koneksi SSH.

Nilai default-nya adalah 22.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.auth

Informasi autentikasi untuk koneksi tersebut.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.auth.method

Metode autentikasi yang digunakan untuk mengakses perangkat melalui protokol konektivitas yang diberikan.

Nilai yang didukung adalah:

  • pki

  • password

connectivity.auth.credentials

Kredensial yang digunakan untuk autentikasi.

connectivity.auth.credentials.password

Kata sandi yang digunakan untuk masuk ke perangkat yang sedang diuji.

Nilai ini hanya berlaku jika connectivity.auth.method diatur ke password.

connectivity.auth.credentials.privKeyPath

Jalur lengkap ke kunci privat yang digunakan untuk masuk ke perangkat yang sedang diuji.

Nilai ini hanya berlaku jika connectivity.auth.method diatur ke pki.

connectivity.auth.credentials.user

Nama pengguna untuk masuk ke perangkat yang sedang diuji.

connectivity.serialPort

Opsional. Port serial tempat perangkat itu terhubung.

Properti ini hanya berlaku jika connectivity.protocol diatur ke uart.

connectivity.containerId

ID kontainer atau nama kontainer Docker yang sedang diuji.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

connectivity.containerUser

Opsional. Nama pengguna untuk pengguna di dalam kontainer. Nilai default adalah pengguna yang disediakan di Dockerfile.

Nilai default-nya adalah 22.

Properti ini hanya berlaku jika connectivity.protocol diatur ke ssh.

(Opsional) Konfigurasikan config.json

File config.json berisi informasi konfigurasi untuk IDT. Biasanya, test runner tidak perlu mengubah file ini kecuali untuk memberikan kredensial pengguna AWS untuk IDT, dan secara opsional, sebuah wilayah AWS. Jika kredensial AWS dengan izin yang diperlukan disediakan, AWS IoT Device Tester akan mengumpulkan dan mengirimkan metrik penggunaan ke AWS. Ini adalah fitur opt-in dan digunakan untuk meningkatkan fungsi IDT. Untuk informasi selengkapnya, lihat Metrik penggunaan IDT.

Test runner dapat mengonfigurasi kredensial AWS dengan salah satu cara berikut:

  • File kredensial

    IDT menggunakan file kredensial yang sama sebagai AWS CLI. Untuk informasi selengkapnya, lihat File konfigurasi dan kredensial.

    Lokasi file kredensial itu bervariasi, tergantung pada sistem operasi yang Anda gunakan:

    • macOS, Linux: ~/.aws/credentials

    • Windows: C:\Users\UserName\.aws\credentials

  • Variabel lingkungan

    Variabel lingkungan adalah variabel yang dikelola oleh sistem operasi dan digunakan oleh perintah sistem. Variabel yang ditentukan selama sesi SSH tidak akan tersedia setelah sesi itu ditutup. IDT dapat menggunakan variabel lingkungan AWS_ACCESS_KEY_ID dan AWS_SECRET_ACCESS_KEY untuk menyimpan kredensial AWS

    Untuk mengatur variabel ini di Linux, macOS, atau Unix, gunakan export:

    export AWS_ACCESS_KEY_ID=<your_access_key_id>
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>

    Untuk menetapkan variabel ini pada Windows, gunakan set:

    set AWS_ACCESS_KEY_ID=<your_access_key_id>
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>

Untuk mengonfigurasi kredensial AWS untuk IDT, test runner akan mengedit bagian auth dalam file config.json yang terletak di <device-tester-extract-location>/configs/.

{
    "log": {
        "location": "logs"
    },
    "configFiles": {
        "root": "configs",
        "device": "configs/device.json"
    },
    "testPath": "tests",
    "reportPath": "results",
    "awsRegion": "<region>",
    "auth": {
        "method": "file | environment",
        "credentials": {
            "profile": "<profile-name>"
        }
    }
}
]

Semua kolom yang berisi nilai wajib diisi seperti yang dijelaskan di sini:

catatan

Semua jalur dalam file ini didefinisikan relatif terhadap < device-tester-extract-location >.

log.location

Jalur ke folder log di < device-tester-extract-location >.

configFiles.root

Path ke folder yang berisi file konfigurasi.

configFiles.device

Jalur ke file device.json.

testPath

Path ke folder yang berisi rangkaian tes.

reportPath

Path ke folder yang akan berisi hasil tes setelah IDT menjalankan rangkaian tes.

awsRegion

Opsional. Wilayah AWS yang akan digunakan oleh rangkaian uji. Jika tidak ditetapkan, rangkaian tes akan menggunakan wilayah default yang ditentukan dalam setiap rangkaian tes.

auth.method

Metode IDT yang digunakan untuk mengambil kredensial AWS. Nilai yang didukung adalah file untuk mengambil kredensial dari file kredensial, dan environment untuk mengambil klredensial dengan menggunakan variabel lingkungan.

auth.credentials.profile

Profil kredensial yang akan digunakan dari file kredensial. Properti ini hanya berlaku jika auth.method diatur ke file.