Dev Proxy gebruiken in CI/CD-scenario's

In één oogopslag
Doel: Dev-proxy integreren in CI/CD
Tijd: 30 minuten
Plugins: Verschillende
Vereisten:Dev Proxy instellen

Het gebruik van Dev Proxy in CI/CD-scenario's is een uitstekende manier om uw toepassingen in een gecontroleerde omgeving te testen. Wanneer u Dev Proxy combineert met tests voor het genereren van API-aanvragen in uw toepassing, kunt u een breed scala aan scenario's behandelen: van het garanderen dat uw app geen schaduw- of niet-productie-API's gebruikt om te controleren of er minimale Microsoft Graph-machtigingen worden gebruikt. Hoewel de exacte configuratiestappen variëren, afhankelijk van uw CI/CD-systeem, volgen hier enkele algemene principes die u moet volgen.

In de meeste gevallen is dev proxy niet geïnstalleerd voor uw runner. Dus voordat u Dev Proxy kunt gebruiken, moet u deze installeren. De installatiestappen zijn afhankelijk van het besturingssysteem dat uw runner gebruikt.

Tip

U kunt de pijplijn versnellen door de map Dev Proxy-installatie in de cache op te slaan. Op deze manier hoeft u Dev Proxy niet telkens te downloaden wanneer u uw pijplijn uitvoert. Raadpleeg de documentatie van uw CI/CD-systeem voor de exacte stappen.

Wanneer u Dev Proxy installeert in een CI/CD-installatie, wilt u doorgaans de versie van Dev Proxy vastmaken die u installeert. Door de versie vast te maken, zorgt u ervoor dat uw pijplijn steeds dezelfde versie van Dev Proxy gebruikt wanneer u deze uitvoert. De exacte stappen voor het vastzetten van een versie zijn afhankelijk van het besturingssysteem van uw runner. Hier volgt een voorbeeld van hoe u de versie van Dev Proxy kunt vastmaken aan een linux-runner:

# install Dev Proxy v1.0.0
bash -c "$(curl -sL https://aka.ms/devproxy/setup.sh)" -- v1.0.0

Start Dev Proxy in een CI/CD-pijplijn elke keer met dezelfde set opties, zodat deze op de achtergrond wordt uitgevoerd, de configuratie van de runner niet wijzigt en niet wacht op gebruikersinvoer. De volgende opties worden aangeraden:

Option Waarom
--detach Voert Dev Proxy op de achtergrond uit, zodat uw pijplijn niet wordt geblokkeerd.
--as-system-proxy false Hiermee voorkomt u dat Dev Proxy zichzelf registreert als de systeemproxy op de runner. Uw app maakt alleen gebruik van Dev Proxy wanneer u de app naar de proxy laat verwijzen, bijvoorbeeld met behulp van de http_proxy en https_proxy omgevingsvariabelen.
--install-cert false Hiermee voorkomt u dat Dev Proxy het hoofdcertificaat probeert te installeren. In een pijplijn vertrouwt u het certificaat zelf, zoals beschreven in Het Dev Proxy-hoofdcertificaat vertrouwen.
--no-first-run Slaat de eerste gebruikservaring over, die niet nodig is voor een nieuwe runner.
--no-watch Hiermee wordt het automatisch opnieuw opstarten van dev proxy uitgeschakeld wanneer het configuratiebestand wordt gewijzigd.

Voordat u Dev Proxy start, stelt u bovendien de DEV_PROXY_API_TOKEN omgevingsvariabele in op een token dat u genereert. Op deze manier weet u het token dat u nodig hebt om de Dev Proxy-API aan te roepen zonder deze op te halen uit dev proxy. Het token moet minstens 32 tekens lang zijn. Zie Proxy-API voor de volledige vereisten.

# generate an API token for this run
export DEV_PROXY_API_TOKEN=$(openssl rand -hex 32)

In de voorbeelden in dit artikel worden deze opties en de DEV_PROXY_API_TOKEN omgevingsvariabele gebruikt.

Een configuratie ophalen voor het opnemen van API-aanroepen

Als u wilt vastleggen welke API's uw app aanroept tijdens een CI-uitvoering, hoeft u geen volledig nieuwe configuratie te maken. Download de api-inventory voorinstelling uit de galerie met Dev Proxy-voorbeelden met behulp van de config get opdracht:

./devproxy/devproxy config get api-inventory

De voorinstelling combineert de UrlDiscoveryPlugin en ExecutionSummaryPlugin met reporters en registreert dev proxy niet als de systeemproxy. Wanneer u Dev Proxy start, geeft u het configuratiebestand van de voorinstelling door, overschrijft u de te bewaken URL's met de API's die uw app aanroept en gebruikt u de aanbevolen CI-vlaggen:

./devproxy/devproxy --config-file "~dataFolder/configs/api-inventory/.devproxy/devproxyrc.json" --urls-to-watch "https://api.contoso.com/*" --detach --as-system-proxy false --install-cert false --no-first-run --no-watch

Zie Vooraf ingestelde configuraties gebruiken voor meer informatie over voorinstellingen.

Dev Proxy starten

Nadat u Dev Proxy hebt geïnstalleerd, moet u deze starten. Wanneer u Dev Proxy in een CI/CD-pijplijn start, is het belangrijk dat u deze op de achtergrond start. Anders wordt uw pijplijn geblokkeerd totdat u Dev Proxy stopt.

Start Dev Proxy op de achtergrond met behulp van de aanbevolen CI-vlaggen:

# start Dev Proxy in detached mode
./devproxy/devproxy --detach --as-system-proxy false --install-cert false --no-first-run --no-watch

Dev Proxy drukt opstartgegevens af, waaronder de proces-id (PID), de proxy-URL, de API-URL en het pad naar het logboekbestand:

Dev Proxy started in background.

  PID:       6456
  Proxy URL: http://127.0.0.1:8000
  API URL:   http://127.0.0.1:8897
  Log file:  /home/runner/.local/dev-proxy/logs/devproxy-6456-2026-03-05.log

Voor machineleesbare uitvoer, gebruik --output json om JSONL te verkrijgen.

./devproxy/devproxy --detach --as-system-proxy false --install-cert false --no-first-run --no-watch --output json
{"type":"result","data":{"pid":6456,"proxyUrl":"http://127.0.0.1:8000","apiUrl":"http://127.0.0.1:8897","logFile":"/home/runner/.local/dev-proxy/logs/devproxy-6456-2026-03-05.log"},"timestamp":"2026-03-05T14:22:42.0000000Z"}

Tip

Gebruik --port 0 en --api-port 0 laat het besturingssysteem willekeurige beschikbare poorten toewijzen. De uitvoer van de losgekoppelde modus toont de werkelijke poorten die zijn toegewezen door het besturingssysteem, wat handig is in CI/CD-scenario's om poortconflicten te voorkomen. Wanneer u willekeurige poorten gebruikt, leest u de proxy-URL en API-URL uit de uitvoer in plaats van de standaard http://127.0.0.1:8000 en http://127.0.0.1:8897 te gebruiken, zoals wordt weergegeven in het voorbeeldscript voor het starten van het script.

Als u een op Linux gebaseerde runner gebruikt, kunt u ook Dev Proxy op de achtergrond starten met behulp van shell-jobcontrole.

# start Dev Proxy in the background
./devproxy/devproxy --as-system-proxy false --install-cert false --no-first-run --no-watch > devproxy.log 2>&1 &

Wacht tot de dev-proxy is gestart

Wanneer u Dev Proxy op de achtergrond start, gaat het script onmiddellijk verder. Dev Proxy heeft echter enige tijd nodig om te starten. Om ervoor te zorgen dat Dev Proxy gereed is voordat u verzoeken gaat versturen, wacht u totdat de API reageert op een GET /proxy aanvraag:

api_url=http://127.0.0.1:8897

echo "Waiting for Dev Proxy to start..."
until curl -sf -o /dev/null "$api_url/proxy" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN"; do
  sleep 1
done

# the rest of your script

De API pollen werkt ongeacht de poort waarop Dev Proxy luistert, ook wanneer u --port 0 gebruikt.

Het rootcertificaat van de Dev Proxy vertrouwen

Nadat de Dev Proxy is gestart, moet u het hoofdcertificaat van de Dev Proxy vertrouwen voordat u aanvragen verzendt, omdat Dev Proxy gebruikmaakt van een zelfondertekend hoofdcertificaat.

Afhankelijk van uw machtigingen moet u mogelijk de ~/.config/dev-proxy/rootCert map maken, waarin Dev Proxy het basiscertificaat opslaat, voordat u Dev Proxy start:

# ensure the rootCert folder
echo "Ensuring the Dev Proxy rootCert folder"
mkdir -p ~/.config/dev-proxy/rootCert

Als u de openbare sleutel van het basiscertificaat wilt ophalen, downloadt u het met behulp van de Dev Proxy-API. Als u een op Linux gebaseerde runner gebruikt, kunt u het certificaat vervolgens installeren door het te kopiëren naar de opslaglocatie van het systeem voor vertrouwde CA-certificaten:

# download the Dev Proxy's Root Certificate
echo "Downloading the Dev Proxy's Root Certificate"
curl -sf -o dev-proxy-ca.crt "$api_url/proxy/rootCertificate?format=crt" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN"

# install root certificate
echo "Installing the Dev Proxy's Root Certificate"
sudo cp dev-proxy-ca.crt /usr/local/share/ca-certificates/

# update CA certificates
echo "Updating the CA certificates"
sudo update-ca-certificates

Proxyomgevingsvariabelen configureren

Veel toepassingen en bibliotheken gebruiken de http_proxy en https_proxy omgevingsvariabelen om te bepalen welke proxyserver moet worden gebruikt voor HTTP- en HTTPS-aanvragen. Omdat u Dev Proxy met --as-system-proxy false start, moet u deze omgevingsvariabelen instellen zodat ze naar het Dev Proxy-exemplaar verwijzen en uw toepassing Dev Proxy gebruikt.

export http_proxy=http://127.0.0.1:8000
export https_proxy=http://127.0.0.1:8000

Dev Proxy beheren

Wanneer u Dev Proxy uitvoert in een CI/CD-pijplijn, kunt u deze niet interactief beheren. In plaats daarvan kunt u dit beheren door aanvragen naar de Dev Proxy-API te verzenden.

Voor alle Dev Proxy-API-aanvragen is een bearer-token in de Authorization header vereist. Als u de DEV_PROXY_API_TOKEN omgevingsvariabele instelt zoals aanbevolen, gebruikt u de waarde ervan. Anders, omdat Dev Proxy het token niet afdrukt bij het opstarten wanneer de CI-omgevingsvariabele is ingesteld, haalt u het op met behulp van de opdracht api token:

export DEV_PROXY_API_TOKEN=$(./devproxy/devproxy api token)

Als u API-aanvragen wilt analyseren die door uw app zijn verzonden, kunt u een POST aanvraag verzenden naar het /proxy eindpunt om de opname te starten:

curl -sf -X POST "$api_url/proxy" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN" -H "Content-Type: application/json" -d '{"recording": true}'

Als u de opname wilt stoppen, verzendt u een POST aanvraag naar het /proxy eindpunt met recording ingesteld op false:

curl -sf -X POST "$api_url/proxy" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN" -H "Content-Type: application/json" -d '{"recording": false}'

Als u de dev-proxy wilt stoppen, kunt u een POST aanvraag verzenden naar het /proxy/stopproxy eindpunt:

curl -sf -X POST "$api_url/proxy/stopproxy" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN"

Nadat u het Dev Proxy-proces hebt gestopt, kan het even duren voordat het volledig is gesloten. Om ervoor te zorgen dat Dev Proxy klaar is, wacht u tot het logbestand, dat Dev Proxy afdrukt wanneer deze in de losgekoppelde modus wordt gestart, een van de voltooiingsberichten bevat, bijvoorbeeld:

echo "Waiting for Dev Proxy to complete..."
while true; do
  if grep -q -e "DONE" -e "No requests to process" -e "An error occurred in a plugin" "$log_file"; then
    break
  fi
  sleep 1
done

Wanneer alle opnameinvoegtoepassingen zijn uitgevoerd, drukt Dev Proxy het DONE bericht af naar de uitvoer. Als er geen aanvragen zijn om te verwerken, drukt Dev Proxy het No requests to process bericht af. Als er een fout is opgetreden in een invoegtoepassing, drukt Dev Proxy het An error occurred in a plugin bericht af. Wanneer u een van deze berichten ziet, kunt u ervoor zorgen dat dev proxy klaar is met het verwerken van de geregistreerde aanvragen.

Voorbeeld van startscript

Hier volgt een voorbeeld van een bash-script dat u kunt gebruiken om Dev Proxy te starten in een CI/CD-pijplijn. Het script gebruikt de aanbevolen CI-vlaggen, leest de proxy-URL, API-URL en het pad naar het logboekbestand uit de JSON-uitvoer, wacht totdat de Dev Proxy-API reageert en vertrouwt het rootcertificaat dat is gedownload uit de API. Het gebruikt jq om de JSON-uitvoer te parseren.

echo "Generating the Dev Proxy API token"
export DEV_PROXY_API_TOKEN=$(openssl rand -hex 32)

echo "Ensuring Dev Proxy rootCert folder"
mkdir -p ~/.config/dev-proxy/rootCert

echo "Starting Dev Proxy"
result=$(./devproxy/devproxy --detach --as-system-proxy false --install-cert false --no-first-run --no-watch --output json | jq -c 'select(.type == "result")')
if [ -z "$result" ]; then
  echo "Failed to start Dev Proxy"
  exit 1
fi

proxy_url=$(echo "$result" | jq -r '.data.proxyUrl')
api_url=$(echo "$result" | jq -r '.data.apiUrl')
log_file=$(echo "$result" | jq -r '.data.logFile')

echo "Waiting for Dev Proxy to start..."
until curl -sf -o /dev/null "$api_url/proxy" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN"; do
  sleep 1
done

echo "Downloading the Dev Proxy's Root Certificate"
curl -sf -o dev-proxy-ca.crt "$api_url/proxy/rootCertificate?format=crt" -H "Authorization: Bearer $DEV_PROXY_API_TOKEN"

echo "Installing the Dev Proxy's Root Certificate"
sudo cp dev-proxy-ca.crt /usr/local/share/ca-certificates/

echo "Updating the CA certificates"
sudo update-ca-certificates

echo "Set proxy variables"
export http_proxy=$proxy_url
export https_proxy=$proxy_url

Zie ook