Jak mohu vyzkoušet a ladit vlastní nástroj před přidáním do mého pracovního prostoru

***

Nastavení vývojového prostředí

Před testováním vlastního nástroje se ujistěte, že je vaše vývojové prostředí správně nakonfigurováno. To znamená mít nainstalované správné IDE, Debuggers, SDK a nasazení.

Pokud například vyvíjíte doplněk Google Workspace, jsou užitečné nástroje, jako jsou skript Apps IDE, Node.js, Python a Ngrok pro tunel. Kód Visual Studio je široce doporučený IDE pro bohaté funkce ladění, zatímco Visual Studio je nezbytné pro ladění určitých vlastních nástrojů, jako jsou textové šablony T4 nebo jednofilegenerátory.

Nastavení vašeho prostředí zahrnuje:
- Instalace požadovaných běhů a knihoven (Node.js, Python, .NET atd.).
- Konfigurace vašeho IDE pro ladění (Launch.JSON ve vs kódu nebo Launch.vs.json v Visual Studio).
- Přístup k jakýmkoli API nebo službám, se kterými váš nástroj interaguje.
- Získání nezbytných oprávnění pro testování nepublikovaných nebo vývojářských nástrojů ve vašem prostředí.

Pro testování na spolupráci zajistěte správné řízení přístupu, jako je sdílení projektů a poskytování přístupu editoru.

***

Místní testování nepublikovaných nástrojů

Před zveřejněním vyzkoušejte svůj vlastní nástroj v kontrolovaném místním nebo vývojovém prostředí. Například doplňky pracovního prostoru Google lze nainstalovat jako nepublikované verze pro testování přímo v podporovaných hostitelských aplikacích (Gmail, Docs, Sheets).

Mezi kroky k lokálnímu testování patří:
1. V editoru skriptů Apps použijte funkci Deploy> Test Deployments k instalaci nepublikovaného doplňku.
2. Obnovte hostitelskou aplikaci, abyste se ujistili, že se objeví doplněk.
3. povolení doplňku, pokud je vyzván.
4. Proveďte funkce nástroje k ověření chování.

U vlastních nástrojů Visual Studio nebo generátory kódu znamená testování často spustit vlastní nástroj ručně nebo nastavit projekt nástroje jako projekt spuštění, který jej ladí přímo v IDE.

***

Techniky ladění v IDES

Ladění je rozhodující pro identifikaci a opravu problémů během vývoje nástrojů. Většina moderních IDE podporuje body přerušení, kontrolu proměnných, hromádky volání a zpracování výjimek.

Visual Studio

Pro vlastní nástroje vyvinuté ve Visual Studio (jako jsou SingleFilegenerators nebo T4 šablony):
- Připojte debugger k běžící instanci Visual Studio (Tools> Připojte k procesu> devenv.exe).
- Alternativně nastavte samotné Visual Studio jako projekt spouštění vašeho nástroje.
- Použijte body přerušení uvnitř logiky generování kódu ke sledování provádění.
- Spuštění vlastních konfigurací sestavení nebo ladění pomocí Launch.vs.json pro kontrolu ladění relací.
- K prohlížení stavu runtime si prohlédnete podrobná debuggerová okna, jako jsou hodinky, místní obyvatelé a zásobník volání.

U textových šablon T4 obnovujte řešení a spusťte ladění a uvidíte transformační kroky a potenciální chyby během zpracování šablon.

Visual Studio Code

Vs kód podporuje vytváření konfigurací ladění prostřednictvím souboru spuštění.json:
- Vygenerujte počáteční konfigurace pro node.js, python nebo jiné jazyky.
- Přidejte vlastní konfigurace pro spuštění nebo připojte ladění.
- Použijte body přerušení, proměnné hodinky a interaktivní labuťová konzole.
- Použijte rozšíření pro vylepšení ladění specifické pro jazyk.
- S integrací AI, jako je GitHub Copilot, můžete generovat konfigurace ladění rychleji.

***

Ladění vzdáleného a místního prostředí

U nástrojů nasazených na vzdálených serverech nebo prostředích může ladění vyžadovat:
- Nastavení tunelů SSH pro předávání ladicích portů ze vzdáleného stroje do místního IDE.
- Používání konfigurací vzdáleného ladění k připojení debuggeru IDE ke vzdálenému procesu.
- Využití nástrojů, jako je NGROK, vytvářet zabezpečené tunely do koncových bodů LocalHost pro testování v reálném čase.

Příklad: Ladění doplňků Workspace Google, které provádějí požadavky HTTP, lze provést vzdáleně povolením debuggerových portů, nastavením tunelů SSH a připojením místního debuggeru IDE a poté interakcí s doplňkem, jako by byly místní.

***

Automatizované testování a kontinuální integrace

Chcete -li zlepšit spolehlivost, integrujte automatizované testy pro váš vlastní nástroj:
- Napište testy jednotky a integrace pro základní logiku.
- K automatickému spuštění testů na závazcích použijte systémy kontinuální integrace (CI).
- Použijte funkce testování živých jednotek (např. Testování živých jednotek Visual Studio), abyste viděli výsledky testu při kódu.
- Ověřte manipulaci s chybami, případy okrajů a úzká místa výkonu.

***

Spolupracujete na testování

Až budete připraveni, sdílejte svůj vlastní nástroj s ostatními pro externí testování:
- Poskytněte přístup k editoru nebo sdílení instalačních kroků pro nepublikované doplňky.
- Shromažďujte zpětnou vazbu a zprávy o chybách systematicky.
- Pomocí poboček řízení verzí spravujte změny oddělené od hlavního kódu.
- Dokumentujte známé problémy a pokyny k použití jasně.

***

Společné výzev a řešení ladění

- Problémy s autorizací: Nástroje, jako jsou doplňky Google Workspace Add-Ons, vyžadují rozsahy a oprávnění OAuth; Chybějící nebo nesprávné autorizace způsobují selhání.
- Rozdíly v prostředí: Chování lokálně versus rozmístěné prostředí se může lišit; Použijte protokolování a konzistentní konfigurace.
- Chyby provádění nástroje: Debug připevněním k hostitelským procesům nebo pomocí verbose protokolování.
- Breakpoint, který není zasažen: Ujistěte se, že jsou načteny symboly ladění a je připojen správný proces.
- Problémy s výkonem: Používejte nástroje profilování integrovaných v rámci IDE k identifikaci úzkých míst.

***

Shrnutí

Testování a ladění vlastního nástroje před přidáním do pracovního prostoru zahrnuje přípravu vývojového prostředí, provozování místních testů a ladění relací, využití funkcí ladění ID Podrobné techniky nastavení a ladění se budou lišit v závislosti na platformě a jazyce nástroje, ale podle strukturovaných postupů zajistí před vydáním robustní a spolehlivé nástroje.

Například v Google Workspace:
- Pro nasazení a testování nepublikovaných doplňků použijte skript Apps IDE.
- Zaměstnávejte Ngrok a SSH pro ladění vzdálených doplňků HTTP.
- Použijte nástroje pro ladění vizuálního studia nebo nástroje pro ladění vizuálního studia pro body přerušení a kontrolu kódu.

Pro vlastní nástroje Visual Studio:
- Připojte debugger k procesům vizuálního studia.
- Použijte spuštěné konfigurační soubory a vlastní úkoly sestavení/ladění.
- Ladění šablon T4 pomocí přestavby v rámci ladicí relace.

Dodržování těchto osvědčených postupů a pracovních postupů pomůže efektivně identifikovat a opravit problémy, než se váš vlastní nástroj stane součástí hlavního pracovního prostoru.

***