Реалізація тестування в VSCode з використанням Testing API

3 Березня 2024 в 00:19 49

Робота з тестами є важливою складовою процесу розробки програмного забезпечення. Однак, для новачків у програмуванні або у використанні певних інструментів, таких як Visual Studio Code (VSCode), ініціювання та налагодження тестів може виглядати складно. У цій статті ми докладно розглянемо процес роботи з тестами в VSCode з використанням вбудованого Testing API.

Спочатку варто зазначити, що Testing API в VSCode надає можливість запуску тестів безпосередньо з редактора коду. Це зручно, оскільки дозволяє швидко перевірити правильність написаного коду без переходу до іншого середовища. Однак, для користувачів, які тільки починають вивчати цю функціональність, може виникнути певне нерозуміння щодо процесу налаштування та використання.

Почнемо з питання про наявність документації з використання Testing API. Офіційна документація здебільшого призначена для розробників, які створюють розширення для VSCode, і може бути не дуже зрозумілою для тих, хто просто хоче використовувати цю функцію для тестування свого коду. Тим не менш, існують різні ресурси та блоги, які надають приклади та пояснення щодо використання Testing API у VSCode. Наприклад, у блозі VSCode регулярно публікуються статті та поради щодо користування цим інструментом.

Далі розглянемо питання про необхідність додаткових розширень для використання Testing API. Так, для роботи з тестами в VSCode потрібно встановити спеціальне розширення, як от “C# Test Explorer” для проектів на мові C#. Це розширення дозволяє легко виконувати та переглядати результати тестів прямо в редакторі VSCode. Щоб встановити це розширення, ви можете скористатися панеллю Extensions у VSCode та знайти його за допомогою пошукового поля.

Після встановлення розширення “C# Test Explorer” необхідно налаштувати ваш проект для роботи з тестами. Однією з важливих речей є налаштування файлу settings.json. У цьому файлі ви можете вказати шлях до вашого тестового проекту. Наприклад:

"dotnet-test-explorer.testProjectPath": "шлях_до_вашого_тестового_проекту"

1	"dotnet-test-explorer.testProjectPath": "шлях_до_вашого_тестового_проекту"

При цьому важливо врахувати структуру каталогів вашого проекту та розміщення самого тестового проекту. Зазвичай тестові файли розміщуються у каталозі “Tests” або “Test” в кореневому каталозі проекту. Після правильного налаштування settings.json, VSCode зможе знаходити ваші тести та виконувати їх.

Також варто згадати про те, що у вас повинен бути налаштований файл тестування відповідно до ваших потреб. Наприклад, якщо ви використовуєте тести на основі фреймворку XUnit, то ваш тестовий файл може виглядати приблизно так:

Content of the tests/tests/GlobalUsings.cs
global using Xunit;
Content of the tests/tests/LoadTests.cs
namespace MyProjectName.SubprojectName.Tests;
public class LoadTests {
   private readonly string[] strings = File.ReadAllLines("data/records.txt");
   [Fact]
   public void Load()
   {
       var data = Dataloader.Load(strings);
       Assert.NotEmpty(data.RecordsOfInterst);
   }
}

Content of the tests/tests/GlobalUsings.cs

global using Xunit;

Content of the tests/tests/LoadTests.cs

namespace MyProjectName.SubprojectName.Tests;

public class LoadTests {

private readonly string[] strings = File.ReadAllLines("data/records.txt");

[Fact]

public void Load()

{

var data = Dataloader.Load(strings);

Assert.NotEmpty(data.RecordsOfInterst);

}

У цьому прикладі ми бачимо, що тести написані з використанням фреймворку XUnit та перевіряють правильність завантаження даних. Такий підхід дозволяє ефективно тестувати ваше програмне забезпечення та перев