გადადით შინაარსზე

Elixir-ის კოდის დაფარვა

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

მოთხოვნები

მომზადება#

გაუშვით ტესტები დაფარვით#

გადაეცით --cover, ისევე როგორც mix test-ს Tuist-ის გარეშე:

bash
mix test --cover

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

  • შეჯამება. ის ბეჭდავს თითოეული მოდულის და ჯამურ დაფარვას. summary: false თიშავს მას.
  • ზღვარი. ის აფერხებს გაშვებას გამოსვლის სტატუსით 3, როდესაც ჯამური მაჩვენებელი ეცემა ზღვარზე ქვემოთ, რომელიც არის 90%, თუ სხვა რამ არ დააყენეთ:
elixir
def project do
[
test_coverage: [summary: [threshold: 80]]
]
end

როგორც Mix-ში, ზღვარი ეკუთვნის შეჯამებას, ამიტომ summary: false თიშავს ორივეს. შეჯამების დასაბეჭდად გაშვების ჩაშლის გარეშე, დააყენეთ threshold: 0. მოდულები, რომლებიც ჩამოთვლილია test_coverage: [ignore_modules: [...]]-ში, გამოტოვებულია შეჯამებიდან და ატვირთვიდან.

Tuist აკონტროლებს დაფარვას კომიტების მიხედვით, ამიტომ საჭიროა თქვენი პროექტი Git რეპოზიტორიაში: გაშვება მის გარეშე ატვირთავს ტესტების შედეგებს, მაგრამ არა დაფარვას.

დაფარვა ეყრდნობა Git-ის ისტორიას, რომელსაც პაკეტი ატვირთავს და რომელიც კომიტს მის ბრენჩზე ათავსებს. უწყვეტი ინტეგრაციის გაშვებები ყოველთვის ატვირთავენ მას, ხოლო --cover გაშვებები ატვირთავენ მას ნებისმიერ მანქანაზე. --cover-ით, პაკეტი ასევე პოულობს, საიდანაც გადაიხაზა pull request: ის იღებს საბაზისო ბრენჩს და აღრმავებს ზედაპირულ კლონს იმდენად, რამდენადაც საჭიროა. დააყენეთ TUIST_GIT_UNSHALLOW_ENABLED=false, რომ თავიდან აიცილოთ დისტანციურ რეპოზიტორიასთან დაკავშირება.

დაშლილი გაშვებები#

როდესაც ყოფთ ტესტებს, გაუშვით თითოეული ნაწილი --cover-ით:

bash
MIX_ENV=test TUIST_SHARD_INDEX=0 mix tuist.test --cover

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

ნაწილი ანგარიშობს მხოლოდ საკუთარ დაფარვას და არ ამოწმებს ზღვარს, რადგან ის ასრულებს სერიის ნაწილს. Tuist აერთიანებს გაშვების ნაწილებს ერთ რიცხვში.

თითოეული ნაწილი ამატებს დაფარვის მრიცხველებს ბილდს, რომელსაც ის ჩამოტვირთავს. ამის ერთხელ გასაკეთებლად, გადაეცით --cover ასევე ბილდის ფაზას:

bash
MIX_ENV=test mix tuist.test.build --shard-max 5 --cover

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

დაასრულეთ თითოეული კომიტი CI-ზე#

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

bash
MIX_ENV=test mix tuist.coverage.complete

ამოცანა კითხულობს კომიტს GIT_COMMIT-დან ან checkout-ის HEAD-დან; გადაეცით --commit <sha> სხვის დასახელებლად. სანამ კომიტი არ დასრულდება, მისი დაფარვა ჩანს როგორც მიმდინარე და რჩება მისი ბრენჩის ტრენდის გარეთ.

როგორ მუშაობს#

ნატიური ხაზების მრიცხველები#

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

პაკეტი გადადის Mix-ის დაფარვის ინსტრუმენტზე, იმავე ატვირთვით, შემდეგი შემთხვევებისთვის:

  • umbrella პროექტის ფესვი. გაუშვით ტესტები თითოეული აპლიკაციის შიგნით ნატიურად დათვლისთვის.
  • პროექტი, რომელიც აყენებს საკუთარ test_coverage: [tool: ...]-ს.
  • რანთაიმი JIT-ის გარეშე, რომელსაც არ შეუძლია ნატიურად დათვლა.

რას ზომავს Tuist#

  • აპლიკაციები. თითოეული OTP აპლიკაცია არის მიზანი დაშბორდზე, საკუთარი დაფარვით.
  • მხოლოდ პროდუქტის კოდი. თქვენი ტესტების გზების ქვეშ მყოფი ფაილები არის ტესტების კოდი. Tuist ინახავს მათ, მაგრამ გამოტოვებს ყოველი რიცხვიდან.
  • ხაზები ფაილის მიხედვით. ხაზი ითვლება ერთხელ ფაილის მიხედვით, რამდენივე მოდულსაც არ უნდა ეკუთვნოდეს.
  • ფუნქციები. თითოეული ხაზი ეკუთვნის ფუნქციას, რომლის წინადადებაც იწყება მასთან ყველაზე ახლოს ზემოთ. ფუნქციები, რომლებსაც კომპილატორი ან მაკრო ქმნის, როგორიცაა __info__/1 ან __schema__/1, არ არის ჩამოთვლილი, მაგრამ მათი ხაზები მაინც ითვლება მათი ფაილისთვის.

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

გამოტოვებული ტესტები#

Tuist-ს არ შეუძლია გადაიტანოს იმ ტესტების დაფარვა, რომლებსაც გაშვება ტოვებს: პაკეტი იწერს, რა შეასრულა მთლიანმა გაშვებამ და არა ის, რა შეასრულა თითოეულმა ტესტმა. ამიტომ, როდესაც გაშვების საკუთარი არგუმენტები ტოვებენ ტესტებს, --only-ით, --exclude-ით, --failed-ით, --stale-ით, --name-pattern-ით, --max-failures-ით, ან ტესტების ფაილებით ან ხაზებით, კომიტის დაფარვა არის არასრული, თუ არ გაშვებულა იმავე ვარიანტის გაშვება, რომელმაც არაფერი გამოტოვა. ორი გაშვება, რომლებიც თითოეული ტოვებს ტესტებს, როგორიცაა --exclude slow და --only slow, მაინც ხდის კომიტს არასრულს, მიუხედავად იმისა, რომ ერთად მათ ყოველი ტესტი გაუშვეს.

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

  • თქვენი ტესტების დამხმარის გამონაკლისები. ტესტები, რომლებსაც ExUnit.start(exclude: [...]) ტოვებს ნაგულისხმევად, არის თქვენი პროექტის არჩევანი, თუ რას ასრულებს მისი სერია ნაგულისხმევად, ამიტომ Tuist არ თვლის მათ როგორც დაკარგულს. გაუშვით ისინი სხვა სამუშაოში, --include-ით ან --only-ით, რომ დაუმატოთ მათი დაფარვა კომიტს.
  • კოდში გამოტოვებული ტესტები @tag :skip-ით.
  • ტესტები, რომლებსაც კარანტინი ტოვებს. ისინი გამოტოვებულია ისე, თითქოს წაშლილი იყოს, ამიტომ ხაზები, რომლებსაც მხოლოდ ისინი ფარავდნენ, ითვლება დაუფარავად.

სრული და არასრული კომიტები#

დაფის თითოეულ კომიტს აქვს სტატუსი:

სტატუსი მნიშვნელობა
მიმდინარეობს გაშვებებმა მოახსენეს დაფარვა, მაგრამ mix tuist.coverage.complete ჯერ არ გაშვებულა ამ კომიტისთვის.
სრული კომიტის ყველა გაშვების ყოველი ტესტი შესრულდა ან განზრახ იქნა გამოტოვებული.
არასრული ზოგიერთი დაფარვის დადგენა ვერ მოხერხდა, ამიტომ მაჩვენებელი ქვედა ზღვარია.
არ არის გაზომილი არცერთმა გაშვებამ არ მოახსენა დაფარვა ამ კომიტისთვის.

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

  • ვარიანტის ყოველმა გაშვებამ საკუთარი არგუმენტებით გამოტოვა ტესტები.
  • ვარიანტის ყოველ გაშვებას აკლდა ზოგიერთი შარდი.
  • ვარიანტის დაფარვა მიღებული იყო მხოლოდ CI გაშვებებიდან შეუმოწმებელი ცვლილებებით.

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

წარმადობაზე გავლენა#

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

შეზღუდვები#

  • HTML ანგარიში არ არის. ნატიური თვლა არ წერს ანგარიშს test_coverage: [output: ...] დირექტორიაში და გაშვება აფრთხილებს, როდესაც ის მითითებულია. დაფის ფაილების გვერდები კი დაფარულ ხაზებს აჩვენებს.
  • განმეორებები არ ზრდის დაფარვას. ტესტების განმეორებების შემთხვევაში, დაფარვა პირველი მცდელობისაა. ეს მცდელობა უკვე გაუშვა ჩავარდნილი ტესტები, ამიტომ ერთადერთი დაკარგული ხაზებია ისინი, რომლებსაც არასტაბილური ტესტი აღწევს განმეორებით, მაგრამ არა პირველ მცდელობაზე.
  • დაფარვა არ არის fork-ებიდან გახსნილი pull request-ებიდან. დაფარვა იტვირთება მხოლოდ იმ გაშვებების მიერ, რომლებიც ავთენტიკაციას გადიან Tuist-თან, ხოლო CI ჩვეულებრივ ფარავს საიდუმლოებსა და იდენტობის ტოკენებს fork-ებიდან გახსნილი pull request-ებისთვის, ამიტომ ეს გაშვებები არ აცხადებენ დაფარვას. შერწყმის შემდეგ, კომიტი გაეშვება თქვენს ბრენჩზე რწმუნებებით და ჩვეულებრივად მოახსენებს თავის დაფარვას.

დაფარვის მოთხოვნა#

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