selene

Selene: Tes Browser UI Web Berorientasi Pengguna di Python

Tinjauan Selene

Selene adalah perpustakaan yang ringkas dan kuat untuk menulis tes UI browser di Python. Itu dibangun sebagai pelabuhan pythonic dari proyek Selenide yang populer dari Java World. Selene membantu pengembang menulis tes yang dapat dibaca dan dapat dipelihara yang "berbicara" dalam bahasa Inggris yang sama, membuatnya lebih mudah dipahami dan dibagikan di seluruh tim.

Kekuatan inti Selene adalah API yang berorientasi pengguna, yang mengabstraksi kompleksitas bekerja dengan Selenium Webdriver. Tes dapat ditulis menggunakan sintaksis yang sederhana dan ekspresif dan fitur dukungan seperti elemen yang dievaluasi malas, mekanisme coba lagi otomatis untuk lebih pintar menunggu pemuatan seperti Ajax. Dengan dukungan pageObject bawaan, ini memungkinkan penggunaan kembali elemen web melalui widget.

Daftar isi

• Fitur utama
• Versi
  • Panduan Migrasi
• Prasyarat
• Instalasi
• Penggunaan
  • Awal yang cepat
  • API inti
  • API Lanjutan
• Tutorial
• Contoh yang diperluas
• Kontribusi
• Changelog

Fitur utama

• API Berorientasi Pengguna : Tulis skrip tes dalam bahasa alami dengan sintaks sederhana yang dibaca seperti bahasa Inggris biasa.
• Dukungan pemuatan seperti Ajax : Mekanisme penantian dan coba lagi Smart Implicit Smart untuk menangani elemen web yang dimuat secara dinamis.
• Dukungan PageObjects : Elemen-elemen yang dievaluasi malas memungkinkan untuk membangun elemen yang menyusun PageObjects di atas pemilih atau By.* Locator seperti tuple, memungkinkan juga untuk membuat elemen yang dapat digunakan kembali untuk komponen yang berbeda.
• Daftar Kondisi yang Diharapkan : Daftar Kondisi yang jauh lebih besar alias pencocokan daripada di Raw Selenium memungkinkan untuk menerapkan pernyataan yang lebih mudah dibaca dan ringkas dalam tes.
• Daftar Perintah yang Ditentukan sebelumnya pada Elemen : Mengurangi kebutuhan menyusun perintah khusus dengan ActionChains .
• Dukungan di luar kotak bingkai dan root bayangan .
• Penyaringan koleksi yang fleksibel : memungkinkan untuk membangun pencari lokasi yang dapat dikomposisi mengurangi kebutuhan selektor XPath yang kompleks dan menghasilkan pesan kesalahan yang jauh lebih rinci yang membantu dengan pemeliharaan tes.
• Pesan kesalahan yang sangat rinci : untuk tindakan dan pernyataan tentang elemen.
• Manajemen Driver Otomatis : Secara otomatis menangani pengaturan driver browser dan robekan untuk eksekusi lokal yang cepat.
• Sangat dapat disesuaikan : Pengguna tingkat lanjut dapat mengonfigurasi atau memperluas SELENE untuk persyaratan tertentu. Misalnya, Anda dapat menyesuaikan template pemilih Anda sendiri. Anda juga dapat menyesuaikan opsi yang sama (misalnya batas waktu) melalui API yang sama di semua tingkatan: 1) secara global; 2) pada contoh browser tertentu; 3) pada elemen spesifik atau kumpulan elemen yang disimpan dalam variabel 4) untuk tindakan atau pernyataan spesifik pada elemen.
• Dukungan untuk driver lokal dan jarak jauh : Selene mendukung berbagai lingkungan, termasuk browser lokal, pengaturan tanpa kepala, dan layanan cloud seperti Selenium Grid - dengan cara yang sama seperti Selenium mendukungnya - dengan menyediakan opsi driver yang sesuai.
• Dukungan multiplatform : Bekerja dengan driver seluler atau desktop web dan Appium. Padahal, beberapa opsi dalam konfigurasi adalah platform khusus.

Versi

Selene saat ini mendukung dua versi utama:

• Versi pra-rilis terbaru yang direkomendasikan (v2.0.0rc9) :

  • Versi Python: 3.8+
  • Dukungan Selenium: >=4.12.0
  • Versi ini memperkenalkan API yang lebih baik, kinerja yang lebih baik, dan direkomendasikan untuk proyek baru.
  • Meskipun berada dalam tahap alfa/beta, penyempurnaan API, meningkatkan "migratorability" dan pengujian
  • Sebagian besar pengguna Selene yang aktif sudah ditingkatkan ke 2.0 alpha/beta dan telah menggunakannya dalam produksi selama 2 tahun terakhir
  • Satu -satunya risiko adalah perubahan API, beberapa perintah sedang dalam proses penyusutan dan penggantian nama

• Versi stabil (v1.0.2) :

  • Versi Python: 2.7, 3.5, 3.6, 3.7
  • Dukungan Selenium: <4.0.0
  • Gunakan versi ini jika proyek Anda membutuhkan kompatibilitas dengan versi python yang lebih lama.

Untuk migrasi dari v1.x ke v2.x, ikuti panduan migrasi.

Panduan Migrasi

Dari 1.0.2 hingga 2.0.0rc<LATEST> :

• Tingkatkan ke Python 3.8+
• Perbarui Selene ke 2.0.0rc<LATEST>
  • Ganti metode collection.first() dari .first() ke .first
  • Pastikan semua kondisi seperti text('foo') Gunakan be.* Atau have.* Sintaks
  • Perbarui metode lain yang sudah usang sesuai kebutuhan

Contoh potensi refactoring selama migrasi:

• Temukan & ganti semuanya
  • (text('foo')) ke (have.text('foo'))
  • (visible) ke (be.visible)
• Temukan & ganti lebih pintar (dengan beberapa refactoring manual)
  • .should(x, timeout=y) to .with_(timeout=y).should(x)
  • .should_not(be.*) to .should(be.not_.*) atau .should(be.*.not_)
  • .should_not(have.*) to .should(have.no.*) atau .should(have.*.not_)
  • .should_each(condition) ke .should(condition.each)
• dan tambahkan impor yang sesuai: from selene import be, have

Prasyarat

Diperlukan Python 3.8+.

Diberikan pyenv diinstal, menginstal versi python yang diperlukan sederhana:

$ pyenv install 3.8.13
$ pyenv global 3.8.13
$ python -V
Python 3.8.13

Instalasi

via puisi + pyenv (disarankan)

Pastikan puisi dan pyenv dipasang, lalu:

poetry new my-tests-with-selene
cd my-tests-with-selene
pyenv local 3.8.13
poetry add selene --allow-prereleases  # for pre-release version
poetry install

melalui pip

Untuk versi pra-rilis (direkomendasikan untuk proyek baru):

pip install selene --pre

Untuk versi stabil terbaru:

pip install selene

dari sumber

Jika Anda lebih suka menginstal Selene langsung dari kode sumber:

git clone https://github.com/yashaka/selene.git
cd selene
python setup.py install

Atau menggunakan puisi:

poetry add git+https://github.com/yashaka/selene.git

Atau menggunakan PIP:

pip install git+https://github.com/yashaka/selene.git

Penggunaan

Awal yang cepat

Otomatis pencarian Google sederhana menggunakan Selene:

 from selene import browser , be , have

browser . open ( 'https://google.com/ncr' )
browser . element ( '[name=q]' ). should ( be . blank )
    . type ( 'selenium' ). press_enter ()
browser . all ( '#rso>div' ). should ( have . size_greater_than ( 5 ))
    . first . should ( have . text ( 'Selenium automates browsers' ))

# not mandatory, because will be closed automatically:
# browser.quit()

API inti

• Selene menyediakan API intuitif untuk berinteraksi dengan elemen web menggunakan modul seperti be , have atau by .

• Elemen malas dan dinamis: Elemen Selene malas dan dinamis, artinya mereka berada setiap kali tindakan dilakukan. Ini memastikan interaksi dengan elemen terbaru.

• Berikut ini adalah interaksi elemen dasar:

 from selene import browser , by , be

# because elements are "lazy",
# you can store them in variable:
search_box = browser . element ( by . name ( 'q' ))

# – even before the actual page will be loaded:
browser . open ( 'https://google.com/ncr' )
search_box . should ( be . blank ). type ( 'Selenium' ). press_enter ()

Memilih elemen locator

Memilih elemen pencari lokasi yang benar sangat penting untuk tes yang andal. Berikut beberapa tips:

1. Periksa elemen: Klik kanan pada elemen web dan pilih Periksa untuk melihat HTML-nya di alat pengembang browser.

2. Gunakan atribut unik: Cari atribut unik seperti ID, nama, atau atribut khusus untuk digunakan dalam pemilih Anda. Praktik terbaik adalah bernegosiasi dengan pengembang tentang menggunakan data-* atribut khusus untuk kebutuhan pengujian, seperti data-test-id .

3. Bangun pemilih CSS atau XPATH: Bangun pemilih yang secara unik mengidentifikasi elemen. Misalnya, menggunakan CSS-Selectors-Selectors #elementId , .className , atau [name="q"] , atau menggunakan xpath untuk hal-hal yang tidak dapat ditangani CSS: //*[text()="Submit"]/.. Selene akan secara otomatis mendeteksi apakah Anda menyediakan pemilih CSS atau XPath.

4. Manfaatkan Pembantu Pemilih Selene (Opsional): Jika Anda membutuhkan sebagian besar kode yang dapat dibaca manusia, Anda dapat menggunakan by.name('q') , by.text('Submit') dan lainnya by.* Pembantu. Perhatikan, bahwa seseorang lebih suka pemilih CSS mentah seperti [name=q] over by.name('q') untuk tujuan prinsip ciuman.

5. Break down long selectors into smaller parts for better readability and maintainability: If to find an element you have a complex selector like in: browser.element('//*[@role="row" and contains(.,"Jon")]//*[@data-field="select-row"]') , decomposing it utilizing Selene's filtering collections API to browser.all('[role=row]').element_by(have.text('Jon')).element('[data-field=select-row]') will make it easier to understand and maintain, because if something changes in the structure of the page, and your test fails, you will see exactly where it fails among "decomposed parts" of the selector, while in case of longer XPath selector you will see only that it fails somewhere in the middle of the long Pemilih dengan kebutuhan berikut untuk memeriksa ulang setiap alasan kegagalan potensial.

6. Buat Strategi Pemilih Kustom (Opsional): Bayangkan pengembang frontend Anda mengikuti praktik terbaik dan menggunakan atribut data-test-id untuk semua elemen yang perlu dibahas dalam tes, dan ada konvensi penamaan yang diikuti untuk elemen tersebut untuk menjadi kata-kasus Snake_Case_or-keebab. Dengan opsi selene's browser.config.selector_to_by_strategy Anda dapat mendefinisikan strategi pemilih kustom untuk secara otomatis mendeteksi semua "snake_kebab-words" yang dilewatkan sebagai pemilih dan mengubahnya menjadi pelatih [data-test-id="snake_kebab-words"] . Maka contoh seperti browser.all('[data-testid=result]').first.element('[data-testid=result-title-a]').click() dapat disederhanakan ke browser.all('result').first.element('result-title-a').click() . Lihat Cara Menyederhanakan Pencarian dengan ID Uji? Panduan untuk detail lebih lanjut.

   Fitur Fitur ini akan tersedia di rilis Selene berikutnya.

Manajemen driver dan browser otomatis

Selene dapat secara otomatis mengelola driver browser untuk Anda, tetapi Anda dapat menyesuaikannya jika diperlukan.

Manajemen Pengemudi Otomatis

• Gunakan instance browser yang telah ditentukan tanpa secara manual membuat driver:

 from selene import browser

browser . config . base_url = 'https://google.com'
browser . config . timeout = 2

browser . open ( '/ncr' )

Pengaturan Driver Kustom

• Jika Anda memerlukan pengaturan driver khusus, seperti menggunakan driver jarak jauh atau menambahkan opsi, konfigurasikan driver yang sesuai:

 from selenium import webdriver
from selene import browser

options = webdriver . ChromeOptions ()
options . add_argument ( '--headless' )
# Add other options as needed

# Selene will automatically detect the browser type (Chrome, Firefox, etc.)
# based on the options passed
browser . config . driver_options = options
browser . config . driver_remote_url = 'http://localhost:4444/wd/hub'
browser . config . base_url = 'https://google.com'
browser . config . timeout = 2

browser . open ( '/ncr' )

• Atau, buat dan tetapkan instance driver Anda sendiri:

 from selenium import webdriver
from selene import browser

options = webdriver . ChromeOptions ()
options . add_argument ( '--headless' )
# Add other options as needed

browser . config . driver = webdriver . Remote (
    command_executor = 'http://localhost:4444/wd/hub' ,
    options = options
)

browser . config . base_url = 'https://google.com'
browser . config . timeout = 2

browser . open ( '/ncr' )

Tutorial

• Selene: Mulai Cepat
• Selene beraksi
• Selene untuk pageObjects

Tips untuk otomatisasi uji yang efektif

• Gunakan pemilih yang dapat dibaca dan stabil: Tujuan untuk pemilih yang unik, ekspresif, dan digabungkan secara minimal dengan struktur DOM untuk membuat tes Anda lebih dapat dipelihara.

• Encapsulate komponen yang dapat digunakan kembali: Memanfaatkan model objek halaman untuk merangkum elemen dan tindakan, mempromosikan penggunaan kembali kode.

• Leverage Tunggu bawaan: Selene secara otomatis menunggu elemen berada dalam keadaan yang diinginkan, mengurangi kebutuhan untuk menunggu eksplisit.

• Jelajahi API: Menyelam ke dalam kode sumber atau dokumentasi Selene untuk memahami metode dan konfigurasi yang tersedia dengan lebih baik.

Kontribusi

Kami menyambut kontribusi untuk Selene! Inilah cara Anda bisa terlibat:

1. Garpu repositori dan klon secara lokal.
2. Pastikan untuk mengikuti gaya dan konvensi proyek.
3. Kirim Permintaan Tarik (PR) dengan deskripsi yang jelas tentang perubahan tersebut.

Untuk detail lebih lanjut, lihat panduan kontribusi kami.

Changelog

Lihat Changelog untuk detail lebih lanjut tentang pembaruan terbaru.