Სალამი ყველას! დღეს გვინდა IT საზოგადოებას წარვუდგინოთ ჩვენი პროდუქტი - IDE API-ებთან მუშაობისთვის TestMace. ალბათ ზოგიერთმა თქვენგანმა უკვე იცის ჩვენ შესახებ წინა სტატიები. თუმცა, არ ყოფილა ინსტრუმენტის ყოვლისმომცველი მიმოხილვა, ამიტომ ჩვენ მივმართავთ ამ სამწუხარო ხარვეზს.

მოტივაცია

მინდა დავიწყო იმით, თუ როგორ მოვედით ამ ცხოვრებაში და გადავწყვიტეთ შეგვექმნა ჩვენი საკუთარი ხელსაწყო API-სთან მოწინავე მუშაობისთვის. დავიწყოთ იმ ფუნქციების ჩამონათვალით, რომელიც უნდა ჰქონდეს პროდუქტს, რომლის შესახებაც, ჩვენი აზრით, შეგვიძლია ვთქვათ, რომ ეს არის „API-ებთან მუშაობის IDE“:

• შეკითხვისა და სკრიპტების შექმნა და შესრულება (შეკითხვების თანმიმდევრობა)
• სხვადასხვა სახის ტესტების წერა
• ტესტის თაობა
• მუშაობა API აღწერილობებთან, მათ შორის იმპორტირება ფორმატებიდან, როგორიცაა Swagger, OpenAPI, WADL და ა.შ.
• დამცინავი მოთხოვნები
• კარგი მხარდაჭერა ერთი ან მეტი ენისთვის სკრიპტების დასაწერად, პოპულარულ ბიბლიოთეკებთან ინტეგრაციის ჩათვლით
• ა.შ.

სია შეიძლება გაფართოვდეს თქვენი გემოვნებით. უფრო მეტიც, მნიშვნელოვანია არა მხოლოდ თავად IDE, არამედ გარკვეული ინფრასტრუქტურის შექმნა, როგორიცაა ღრუბლოვანი სინქრონიზაცია, ბრძანების ხაზის ინსტრუმენტები, ონლაინ მონიტორინგის სერვისი და ა.შ. საბოლოო ჯამში, ბოლო წლების ტენდენციები გვკარნახობს არა მხოლოდ აპლიკაციის მძლავრ ფუნქციონირებას, არამედ მის სასიამოვნო ინტერფეისსაც.

ვის სჭირდება ასეთი ინსტრუმენტი? ცხადია, ყველა, ვინც რაღაცნაირად მაინც არის დაკავშირებული API-ების შემუშავებასა და ტესტირებასთან, არის დეველოპერები და ტესტერები =). უფრო მეტიც, თუ პირველისთვის ხშირად საკმარისია ერთი შეკითხვისა და მარტივი სკრიპტების შესრულება, მაშინ ტესტერებისთვის ეს არის ერთ-ერთი მთავარი ინსტრუმენტი, რომელიც, სხვა საკითხებთან ერთად, უნდა შეიცავდეს ტესტების ჩაწერის მძლავრ მექანიზმს მათი გაშვების შესაძლებლობით. CI.

ასე რომ, ამ მითითებების გათვალისწინებით, ჩვენ დავიწყეთ ჩვენი პროდუქტის შექმნა. ვნახოთ, რას მივაღწიეთ ამ ეტაპზე.

სწრაფი დაწყება

დავიწყოთ აპლიკაციის პირველი გაცნობით. შეგიძლიათ გადმოწეროთ ჩვენს ვებგვერდზე. ამ დროისთვის მხარდაჭერილია სამივე ძირითადი პლატფორმა - Windows, Linux, MacOS. ჩამოტვირთეთ, დააინსტალირეთ, გაუშვით. როდესაც პირველად გაუშვით, შეგიძლიათ ნახოთ შემდეგი ფანჯარა:

დააწკაპუნეთ პლიუს ნიშანზე შინაარსის არეალის ზედა ნაწილში თქვენი პირველი მოთხოვნის შესაქმნელად. შეკითხვის ჩანართი ასე გამოიყურება:

მოდით შევხედოთ მას უფრო დეტალურად. მოთხოვნის ინტერფეისი ძალიან ჰგავს პოპულარული დანარჩენი კლიენტების ინტერფეისს, რაც აადვილებს მიგრაციას მსგავსი ხელსაწყოებიდან. მოდით, პირველი მოთხოვნა მივმართოთ url-ს https://next.json-generator.com/api/json/get/NJv-NT-U8

ზოგადად, ერთი შეხედვით, რეაგირების პანელი ასევე არ იწვევს რაიმე სიურპრიზს. თუმცა, მინდა თქვენი ყურადღება რამდენიმე პუნქტზე გავამახვილო:

1. პასუხის სხეული წარმოდგენილია ხის სახით, რომელიც ჯერ ამატებს ინფორმაციის შინაარსს და მეორეც საშუალებას გაძლევთ დაამატოთ რამდენიმე საინტერესო ფუნქცია, რომლის შესახებაც ქვემოთ
2. არსებობს Assertions ჩანართი, რომელიც აჩვენებს ტესტების ჩამონათვალს მოცემული მოთხოვნისთვის

როგორც ხედავთ, ჩვენი ინსტრუმენტი შეიძლება გამოყენებულ იქნას როგორც მოსახერხებელი დასვენების კლიენტი. თუმცა, ჩვენ აქ არ ვიქნებოდით, თუ მისი შესაძლებლობები შემოიფარგლება მხოლოდ მოთხოვნების გაგზავნით. შემდეგი, მე გამოვყოფ TestMace-ის ძირითად ცნებებსა და ფუნქციონირებას.

ძირითადი ცნებები და მახასიათებლები

Node

TestMace ფუნქციონირება დაყოფილია სხვადასხვა ტიპის კვანძებად. ზემოთ მოყვანილ მაგალითში ჩვენ ვაჩვენეთ RequestStep კვანძის მოქმედება. თუმცა, შემდეგი ტიპის კვანძები ახლა ასევე ხელმისაწვდომია აპლიკაციაში:

• RequestStep. ეს არის კვანძი, რომლის მეშვეობითაც შეგიძლიათ შექმნათ მოთხოვნა. მას შეიძლება ჰქონდეს მხოლოდ ერთი Assertion კვანძი, როგორც ბავშვის ელემენტი.
• Მტკიცება. კვანძი გამოიყენება ტესტების დასაწერად. შეიძლება იყოს მხოლოდ RequestStep კვანძის შვილობილი კვანძი.
• საქაღალდე. საშუალებას გაძლევთ დააჯგუფოთ Folder და RequestStep კვანძები საკუთარ თავში.
• პროექტი. ეს არის root კვანძი, რომელიც ავტომატურად იქმნება პროექტის შექმნისას. წინააღმდეგ შემთხვევაში, ის იმეორებს Folder კვანძის ფუნქციონირებას.
• Ბმული. ბმული Folder ან RequestStep კვანძთან. საშუალებას გაძლევთ ხელახლა გამოიყენოთ მოთხოვნები და სკრიპტები.
• ა.შ.

კვანძები განლაგებულია ნაკაწრებში (პანელი ქვედა მარცხნივ, გამოიყენება „ერთჯერადი“ მოთხოვნების სწრაფად შესაქმნელად) და პროექტებში (პანელი ზედა მარცხნივ), რაზეც უფრო დეტალურად ვისაუბრებთ.

პროექტი

აპლიკაციის გაშვებისას შეიძლება შეამჩნიოთ მარტოხელა პროექტის ხაზი ზედა მარცხენა კუთხეში. ეს არის პროექტის ხის ფესვი. როდესაც დაიწყებთ პროექტს, იქმნება დროებითი პროექტი, რომლის გზა დამოკიდებულია თქვენს ოპერაციულ სისტემაზე. ნებისმიერ დროს შეგიძლიათ გადაიტანოთ პროექტი თქვენთვის მოსახერხებელ ადგილას.

პროექტის მთავარი მიზანია ფაილურ სისტემაში განვითარებული მოვლენების შენახვა და მათი შემდგომი სინქრონიზაცია ვერსიის კონტროლის სისტემების მეშვეობით, სკრიპტების გაშვება CI-ში, ცვლილებების განხილვა და ა.შ.

ცვლადები

ცვლადები აპლიკაციის ერთ-ერთი მთავარი მექანიზმია. მათ, ვინც მუშაობს ინსტრუმენტებთან, როგორიცაა TestMace, შეიძლება უკვე გქონდეთ წარმოდგენა იმაზე, რაზეც ვსაუბრობთ. ასე რომ, ცვლადები არის საერთო მონაცემების შესანახად და კვანძებს შორის კომუნიკაციის საშუალება. ანალოგი, მაგალითად, არის გარემოს ცვლადები Postman-ში ან Insomnia-ში. თუმცა უფრო შორს წავედით და თემა განვავითარეთ. TestMace-ში ცვლადების დაყენება შესაძლებელია კვანძის დონეზე. ნებისმიერი. ასევე არსებობს წინაპრებისგან ცვლადების მემკვიდრეობის მექანიზმი და შთამომავლებში ცვლადების გადაფარვა. გარდა ამისა, არსებობს რამდენიმე ჩაშენებული ცვლადი, ჩაშენებული ცვლადების სახელები იწყება $. აქ არის რამდენიმე მათგანი:

• $prevStep - ბმული წინა კვანძის ცვლადებთან
• $nextStep - ბმული შემდეგი კვანძის ცვლადებთან
• $parent - იგივე, მაგრამ მხოლოდ წინაპრისთვის
• $response - პასუხი სერვერისგან
• $env - მიმდინარე გარემოს ცვლადები
• $dynamicVar - დინამიური ცვლადები შექმნილი სკრიპტის ან მოთხოვნის შესრულების დროს

$env - ეს არის არსებითად ჩვეულებრივი პროექტის კვანძის დონის ცვლადები, თუმცა გარემოს ცვლადების ნაკრები იცვლება არჩეული გარემოდან გამომდინარე.

ცვლადის წვდომა ხდება მეშვეობით ${variable_name}
ცვლადის მნიშვნელობა შეიძლება იყოს სხვა ცვლადი, ან თუნდაც მთელი გამოხატულება. მაგალითად, url ცვლადი შეიძლება იყოს მსგავსი გამოხატულება
http://${host}:${port}/${endpoint}.

ცალკე, აღსანიშნავია სკრიპტის შესრულების დროს ცვლადების მინიჭების შესაძლებლობა. მაგალითად, ხშირად საჭიროა ავტორიზაციის მონაცემების შენახვა (ჟეტონი ან მთელი სათაური), რომელიც მოვიდა სერვერიდან წარმატებული შესვლის შემდეგ. TestMace საშუალებას გაძლევთ შეინახოთ ასეთი მონაცემები ერთ-ერთი წინაპრის დინამიურ ცვლადებში. უკვე არსებულ „სტატიკური“ ცვლადებთან შეჯახების თავიდან ასაცილებლად, დინამიური ცვლადები მოთავსებულია ცალკეულ ობიექტში. $dynamicVar.

სცენარები

ყველა ზემოაღნიშნული ფუნქციის გამოყენებით, შეგიძლიათ მთელი შეკითხვის სკრიპტების გაშვება. მაგალითად, ერთეულის შექმნა -> ერთეულის მოთხოვნა -> ერთეულის წაშლა. ამ შემთხვევაში, მაგალითად, შეგიძლიათ გამოიყენოთ Folder კვანძი რამდენიმე RequestStep კვანძის დასაჯგუფებლად.

ავტომატური დასრულება და გამოხატვის ხაზგასმა

ცვლადებთან მოსახერხებელი მუშაობისთვის (და არა მხოლოდ) აუცილებელია ავტომატური დასრულება. და რა თქმა უნდა, გამოხატვის მნიშვნელობის ხაზგასმა, რათა გაადვილდეს და უფრო მოსახერხებელი იყოს იმის გარკვევა, თუ რას უდრის კონკრეტული ცვლადი. ეს ზუსტად ის შემთხვევაა, როცა ასჯერ მოსმენას ერთხელ ნახვა ჯობია:

აღსანიშნავია, რომ ავტომატური დასრულება ხორციელდება არა მხოლოდ ცვლადებისთვის, არამედ, მაგალითად, სათაურებისთვის, გარკვეული სათაურების მნიშვნელობებისთვის (მაგალითად, ავტომატური დასრულება Content-Type სათაურისთვის), პროტოკოლებისთვის და მრავალი სხვა. სია მუდმივად განახლდება, როგორც აპლიკაცია იზრდება.

Უკან წინ

ცვლილებების გაუქმება/გამეორება ძალიან მოსახერხებელი რამ არის, მაგრამ რატომღაც ის ყველგან არ არის დანერგილი (და API-ებთან მუშაობის ინსტრუმენტები არ არის გამონაკლისი). მაგრამ ჩვენ არ ვართ ერთ-ერთი მათგანი!) ჩვენ განვახორციელეთ გაუქმება/გამეორება მთელი პროექტის განმავლობაში, რაც საშუალებას გაძლევთ გააუქმოთ არა მხოლოდ კონკრეტული კვანძის რედაქტირება, არამედ მისი შექმნა, წაშლა, მოძრაობა და ა.შ. ყველაზე კრიტიკული ოპერაციები მოითხოვს დადასტურებას.

ტესტების შექმნა

Assertion კვანძი პასუხისმგებელია ტესტების შექმნაზე. ერთ-ერთი მთავარი მახასიათებელია პროგრამირების გარეშე ტესტების შექმნის შესაძლებლობა, ჩაშენებული რედაქტორების გამოყენებით.

Assertion კვანძი შედგება მტკიცებათა სიმრავლისგან. თითოეულ მტკიცებას აქვს თავისი ტიპი; ამ დროისთვის არსებობს რამდენიმე სახის მტკიცება

1. შეადარეთ მნიშვნელობები - უბრალოდ ადარებს 2 მნიშვნელობას. არსებობს რამდენიმე შედარების ოპერატორი: ტოლი, არა ტოლი, მეტი, მეტი ან ტოლი, ნაკლები, ნაკლები ან ტოლი.

2. შეიცავს მნიშვნელობას - ამოწმებს სტრიქონში ქვესტრიქონის არსებობას.

3. XPath - ამოწმებს, რომ სელექტორი XML-ში შეიცავს გარკვეულ მნიშვნელობას.

4. JavaScript მტკიცება არის თვითნებური javascript სკრიპტი, რომელიც აბრუნებს true-ს წარმატების შემთხვევაში და false-ს წარუმატებლობისას.

აღვნიშნავ, რომ მხოლოდ ბოლო მოითხოვს მომხმარებლისგან პროგრამირების უნარებს, დანარჩენი 3 მტკიცება იქმნება გრაფიკული ინტერფეისის გამოყენებით. აი, მაგალითად, ასე გამოიყურება დიალოგი შედარების მნიშვნელობების მტკიცების შესაქმნელად:

ნამცხვარი ტორტზე არის მტკიცებების სწრაფი შექმნა პასუხებიდან, უბრალოდ შეხედეთ მას!

თუმცა, ასეთ მტკიცებებს აქვს აშკარა შეზღუდვები, რომელთა გადასალახად შეიძლება გამოიყენოთ Javascript მტკიცება. და აქ TestMace ასევე უზრუნველყოფს კომფორტულ გარემოს ავტომატური შევსებით, სინტაქსის ხაზგასმით და სტატიკური ანალიზატორითაც კი.

API აღწერა

TestMace საშუალებას გაძლევთ არა მხოლოდ გამოიყენოთ API, არამედ დოკუმენტირებაც. უფრო მეტიც, თავად აღწერას ასევე აქვს იერარქიული სტრუქტურა და ორგანულად ჯდება პროექტის დანარჩენ ნაწილში. გარდა ამისა, ამჟამად შესაძლებელია API აღწერილობების იმპორტი Swagger 2.0 / OpenAPI 3.0 ფორმატებიდან. აღწერა თავისთავად არ არის მხოლოდ მკვდარი წონა, არამედ მჭიდროდ არის ინტეგრირებული დანარჩენ პროექტთან, კერძოდ, ხელმისაწვდომია URL-ების, HTTP სათაურების, შეკითხვის პარამეტრების და ა.შ. ავტომატური შევსება და სამომავლოდ ვგეგმავთ ტესტების დამატებას. პასუხის API აღწერილობასთან შესაბამისობისთვის.

გაზიარების კვანძი

შემთხვევა: გსურთ, გაუზიაროთ პრობლემური მოთხოვნა ან თუნდაც მთელი სკრიპტი კოლეგას, ან უბრალოდ მიამაგროთ ის ხარვეზს. TestMace მოიცავს ამ შემთხვევასაც: აპლიკაცია საშუალებას გაძლევთ, მოაწყოთ ნებისმიერი კვანძი და თუნდაც ქვეხე URL-ში. Copy-Paste და თქვენ შეგიძლიათ მარტივად გადაიტანოთ მოთხოვნა სხვა მანქანაზე ან პროექტზე.

ადამიანის წაკითხვადი პროექტის შენახვის ფორმატი

ამ მომენტში, თითოეული კვანძი ინახება ცალკე ფაილში yml გაფართოებით (როგორც ეს ხდება Assertion კვანძის შემთხვევაში), ან საქაღალდეში, სადაც არის კვანძის სახელი და მასში არსებული index.yml ფაილი.
მაგალითად, ასე გამოიყურება მოთხოვნის ფაილი, რომელიც ჩვენ გავაკეთეთ ზემოთ განხილვისას:

index.yml

children: []
variables: {}
type: RequestStep
assignVariables: []
requestData:
  request:
    method: GET
    url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
  headers: []
  disabledInheritedHeaders: []
  params: []
  body:
    type: Json
    jsonBody: ''
    xmlBody: ''
    textBody: ''
    formData: []
    file: ''
    formURLEncoded: []
  strictSSL: Inherit
authData:
  type: inherit
name: Scratch 1

როგორც ხედავთ, ყველაფერი ძალიან ნათელია. თუ სასურველია, ამ ფორმატის ადვილად რედაქტირება შესაძლებელია ხელით.

ფაილურ სისტემაში საქაღალდეების იერარქია მთლიანად იმეორებს პროექტში არსებული კვანძების იერარქიას. მაგალითად, სკრიპტი, როგორიცაა:

ასახავს ფაილურ სისტემას შემდეგ სტრუქტურაზე (მხოლოდ საქაღალდის იერარქია ნაჩვენებია, მაგრამ არსი ნათელია)

ეს აადვილებს პროექტის განხილვის პროცესს.

იმპორტი ფოსტალიონისგან

ყოველივე ზემოთქმულის წაკითხვის შემდეგ, ზოგიერთ მომხმარებელს სურს სცადონ (ხომ?) ახალი პროდუქტი ან (რა ჯანდაბა არ ხუმრობს!) მთლიანად გამოიყენოს იგი საკუთარ პროექტში. თუმცა, მიგრაცია შეიძლება შეჩერდეს იმავე ფოსტალიონში განვითარებული მოვლენების დიდი რაოდენობით. ასეთ შემთხვევებში, TestMace მხარს უჭერს კოლექციების იმპორტს Postman-ისგან. ამ დროისთვის, ტესტირების გარეშე იმპორტი არის მხარდაჭერილი, თუმცა არ გამოვრიცხავთ, რომ მომავალშიც მოხდეს.

გეგმები

ვიმედოვნებ, რომ ბევრ მათგანს, ვინც წაიკითხა აქამდე, მოეწონა ჩვენი პროდუქტი. თუმცა, ეს ყველაფერი არ არის! პროდუქტზე მუშაობა გაჩაღებულია და აქ არის რამოდენიმე ფუნქცია, რომელთა დამატებასაც მალე ვგეგმავთ.

Облачная სინქრონიზაცია

ერთ-ერთი ყველაზე მოთხოვნადი ფუნქცია. ამ დროისთვის, ჩვენ ვთავაზობთ სინქრონიზაციისთვის ვერსიის კონტროლის სისტემების გამოყენებას, რისთვისაც ფორმატს უფრო მეგობრული ვაქცევთ ამ ტიპის შენახვისთვის. თუმცა, ეს სამუშაო პროცესი ყველასთვის შესაფერისი არ არის, ამიტომ ჩვენ ვგეგმავთ სინქრონიზაციის მექანიზმის დამატებას ჩვენი სერვერების მეშვეობით.

CLI

როგორც ზემოთ აღინიშნა, IDE დონის პროდუქტებს არ შეუძლიათ ყველა სახის ინტეგრაციის გარეშე არსებულ აპლიკაციებთან ან სამუშაო პროცესებთან. CLI არის ზუსტად ის, რაც საჭიროა TestMace-ში დაწერილი ტესტების უწყვეტი ინტეგრაციის პროცესში ინტეგრირებისთვის. CLI-ზე მუშაობა გაჩაღდა; ადრეული ვერსიები დაიწყებენ პროექტს მარტივი კონსოლის ანგარიშით. სამომავლოდ ჩვენ ვგეგმავთ ანგარიშის გამოტანის დამატებას JUnit ფორმატში.

დანამატის სისტემა

ჩვენი ხელსაწყოს მთელი სიმძლავრის მიუხედავად, საქმეების ნაკრები, რომლებიც საჭიროებენ გადაწყვეტას, შეუზღუდავია. ყოველივე ამის შემდეგ, არის ამოცანები, რომლებიც სპეციფიკურია კონკრეტული პროექტისთვის. ამიტომაც სამომავლოდ ვგეგმავთ SDK-ის დამატებას დანამატების შემუშავებისთვის და თითოეულ დეველოპერს შეეძლება თავისი სურვილისამებრ დაამატოს ფუნქციონირება.

კვანძების ტიპების დიაპაზონის გაფართოება

კვანძების ეს ნაკრები არ მოიცავს მომხმარებლის მიერ მოთხოვნილ ყველა შემთხვევას. კვანძები, რომელთა დამატება იგეგმება:

• სკრიპტის კვანძი - გარდაქმნის და ათავსებს მონაცემებს js-ის და შესაბამისი API-ის გამოყენებით. ამ ტიპის კვანძის გამოყენებით, შეგიძლიათ გააკეთოთ ისეთი რამ, როგორიცაა წინასწარ მოთხოვნისა და მოთხოვნის შემდგომი სკრიპტები Postman-ში.
• GraphQL კვანძი - graphql მხარდაჭერა
• მორგებული მტკიცების კვანძი - საშუალებას მოგცემთ გააფართოვოთ პროექტში არსებული მტკიცებების ნაკრები
  ბუნებრივია, ეს არ არის საბოლოო სია, ის მუდმივად განახლდება, სხვა საკითხებთან ერთად, თქვენი გამოხმაურების გამო.

კითხვა-პასუხი

რით განსხვავდებით ფოსტალიონისგან?

1. კვანძების კონცეფცია, რომელიც საშუალებას გაძლევთ თითქმის უსასრულოდ გააფართოვოთ პროექტის ფუნქციონირება
2. ადამიანის მიერ წაკითხვადი პროექტის ფორმატი მისი ფაილურ სისტემაში შენახვით, რაც ამარტივებს მუშაობას ვერსიის კონტროლის სისტემების გამოყენებით
3. ტესტების შექმნის შესაძლებლობა პროგრამირების გარეშე და უფრო მოწინავე js მხარდაჭერა ტესტის რედაქტორში (ავტომატური დასრულება, სტატიკური ანალიზატორი)
4. გაფართოებული ავტომატური დასრულება და ცვლადების მიმდინარე მნიშვნელობის ხაზგასმა

ეს არის ღია კოდის პროდუქტი?

არა, ამ დროისთვის წყაროები დაკეტილია, მაგრამ სამომავლოდ განვიხილავთ წყაროების გახსნის შესაძლებლობას

რით ცხოვრობ?)

უფასო ვერსიასთან ერთად, ჩვენ ვგეგმავთ პროდუქტის ფასიანი ვერსიის გამოშვებას. ის, პირველ რიგში, მოიცავს საგნებს, რომლებიც საჭიროებენ სერვერის მხარეს, მაგალითად, სინქრონიზაციას.

დასკვნა

ჩვენი პროექტი ნახტომებით მიდის სტაბილური განთავისუფლებისკენ. თუმცა, პროდუქტის გამოყენება უკვე შესაძლებელია და ჩვენი ადრეული მომხმარებლების დადებითი გამოხმაურება ამის დასტურია. ჩვენ აქტიურად ვაგროვებთ გამოხმაურებას, რადგან საზოგადოებასთან მჭიდრო თანამშრომლობის გარეშე შეუძლებელია კარგი ინსტრუმენტის შექმნა. შეგიძლიათ მოგვძებნოთ აქ:

ოფიციალური ვებგვერდი

დეპეშა

Slack

Facebook

პრობლემების ტრეკერი

ჩვენ ველით თქვენს სურვილებსა და წინადადებებს!

წყარო: www.habr.com