Testa och felsöka ett anpassat program test-debug-custom-worker

Kör enhetstester för ett anpassat program test-custom-worker

Installera Docker Desktop på datorn. Om du vill testa en anpassad arbetare kör du följande kommando i programmets rot:

$ aio app test

Det här kommandot kör ett anpassat enhetstestramverk för programåtgärder i Asset compute i projektet enligt beskrivningen nedan. Den är ansluten via en konfiguration i filen package.json. Det går också att ha JavaScript enhetstester som Jest. aio app test kör båda.

Plugin-programmet aio-cli-plugin-program-asset-compute är inbäddat som ett utvecklingsberoende i det anpassade programmet så att det inte behöver installeras på bygg-/testsystem.

Ramverk för testning av programenhet unit-test-framework

Med testmiljön i Asset Compute kan du testa program utan att skriva någon kod. Den bygger på principen för källa till återgivning av program. En viss fil- och mappstruktur måste ställas in för att definiera testfall med testkällfiler, valfria parametrar, förväntade återgivningar och anpassade valideringsskript. Som standard jämförs återgivningarna för bytelikhet. Dessutom kan externa HTTP-tjänster enkelt modelleras med enkla JSON-filer.

Lägg till tester add-tests

Testerna förväntas i mappen test på projektets rotnivå. Testfallen för varje program ska finnas i sökvägen test/asset-compute/<worker-name>, med en mapp för varje testfall:

action/
manifest.yml
package.json
...
test/
  asset-compute/
    <worker-name>/
        <testcase1>/
            file.jpg
            params.json
            rendition.png
        <testcase2>/
            file.jpg
            params.json
            rendition.gif
            validate
        <testcase3>/
            file.jpg
            params.json
            rendition.png
            mock-adobe.com.json
            mock-console.adobe.io.json

Ta en titt på exempel på anpassade program. Nedan finns en detaljerad referens.

Testa utdata test-output

Katalogen build i roten av Adobe Developer App Builder-programmet innehåller detaljerade testresultat och loggar för det anpassade programmet. De här detaljerna visas även i utdata från kommandot aio app test.

Visa externa tjänster mock-external-services

Du kan simulera externa tjänstanrop inom dina åtgärder genom att skapa mock-<HOST_NAME>.json-filer för dina testscenarier, där HOST_NAME är den specifika värddator som du tänker imitera. Ett exempel på användningsfall är ett program som gör ett separat anrop till S3. Den nya teststrukturen skulle se ut så här:

test/
  asset-compute/
    <worker-name>/
      <testcase3>/
        file.jpg
        params.json
        rendition.png
        mock-<HOST_NAME1>.json
        mock-<HOST_NAME2>.json

Mock-filen är ett JSON-formaterat http-svar. Mer information finns i den här dokumentationen. Om det finns flera värdnamn att sätta samman definierar du flera mock-<mocked-host>.json-filer. Nedan visas ett exempel på en modellfil för google.com med namnet mock-google.com.json:

[{
    "httpRequest": {
        "path": "/images/hello.txt"
        "method": "GET"
    },
    "httpResponse": {
        "statusCode": 200,
        "body": {
          "message": "hello world!"
        }
    }
}]

Exemplet worker-animal-pictures innehåller en modellfil för den Wikimedia-tjänst som den interagerar med.

Dela filer i testfall share-files-across-test-cases

Adobe rekommenderar att du använder relativa symboler om du delar file.*, params.json eller validate skript i flera tester. De stöds av Git. Ge de delade filerna ett unikt namn, eftersom du kan ha andra. I exemplet nedan blandas och matchar testerna några delade filer och deras egna:

tests/
    file-one.jpg
    params-resize.json
    params-crop.json
    validate-image-compare

    jpg-png-resize/
        file.jpg    - symlink: ../file-one.jpg
        params.json - symlink: ../params-resize.json
        rendition.png
        validate    - symlink: ../validate-image-compare

    jpg2-png-crop/
        file.jpg
        params.json - symlink: ../params-crop.json
        rendition.gif
        validate    - symlink: ../validate-image-compare

    jpg-gif-crop/
        file.jpg    - symlink: ../file-one.jpg
        params.json - symlink: ../params-crop.json
        rendition.gif
        validate

Testa förväntade fel test-unexpected-errors

Fall med feltester bör inte innehålla en förväntad rendition.*-fil och bör definiera den förväntade errorReason inuti params.json-filen.

Struktur för feltest:

<error_test_case>/
    file.jpg
    params.json

Parameterfil med felorsak:

{
    "errorReason": "SourceUnsupported",
    // ... other params
}

Se en fullständig lista och en beskrivning av orsaker till fel i Asset compute.

Felsöka ett anpassat program debug-custom-worker

Följande steg visar hur du kan felsöka ditt anpassade program med Visual Studio Code. Det gör det möjligt att se liveloggar, träffbrytpunkter och stega igenom kod samt ladda om lokala kodändringar live vid varje aktivering.

Många av dessa steg automatiseras i aio. Gå till avsnittet Felsöka programmet i Adobe Developer App Builder-dokumentationen. För tillfället innehåller stegen nedan en lösning.

Alla kodändringar läses in i realtid och träder i kraft så snart nästa aktivering sker.