Utiliser le proxy de développement dans les scénarios CI/CD

En un clin d’œil
Objectif: Intégrer le proxy de développement dans CI/CD
Heure : 30 minutes
Plugins: Divers
Prérequis :configurer le proxy de développement

L’utilisation du proxy de développement dans les scénarios CI/CD est un excellent moyen de tester vos applications dans un environnement contrôlé. Lorsque vous combinez le proxy de développement avec des tests qui génèrent des demandes d’API dans votre application, vous pouvez couvrir un large éventail de scénarios : de s’assurer que votre application n’utilise pas d’API d’ombre ou de non-production pour vérifier qu’elle utilise des autorisations Microsoft Graph minimales. Bien que les étapes de configuration exactes varient en fonction de votre système CI/CD, voici quelques principes généraux que vous devez suivre.

Dans la plupart des cas, votre exécuteur n’a pas installé Dev Proxy. Avant de pouvoir utiliser le proxy de développement, vous devez l’installer. Les étapes d’installation dépendent du système d’exploitation que votre exécuteur utilise.

Conseil / Astuce

Pour accélérer votre pipeline, envisagez de mettre en cache le dossier d’installation du proxy de développement. De cette façon, vous n’avez pas besoin de télécharger le proxy de développement chaque fois que vous exécutez votre pipeline. Pour connaître les étapes exactes, reportez-vous à la documentation de votre système CI/CD.

Lors de l’installation de Dev Proxy dans une configuration CI/CD, vous souhaitez généralement épingler la version de Dev Proxy que vous installez. Fixer la version garantit que votre pipeline utilise la même version de Dev Proxy chaque fois que vous l’exécutez. La procédure exacte pour épingler une version dépend du système d’exploitation de votre exécuteur. Voici un exemple de la façon dont vous pouvez épingle la version de Dev Proxy sur un exécuteur Linux :

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

Dans un pipeline CI/CD, démarrez Dev Proxy avec le même ensemble d’options à chaque fois, afin qu’il s’exécute en arrière-plan, ne modifie pas la configuration de l’exécuteur et n’attend pas l’entrée utilisateur. Nous vous recommandons d’utiliser les options suivantes :

Option Pourquoi
--detach Exécute le proxy de développement en arrière-plan afin qu’il ne bloque pas votre pipeline.
--as-system-proxy false Empêche Dev Proxy de s’inscrire en tant que proxy système sur le runner. Votre application utilise Dev Proxy uniquement lorsque vous la pointez vers le proxy, par exemple en utilisant les variables d’environnement https_proxy et http_proxy.
--install-cert false Empêche Dev Proxy d’essayer d’installer son certificat racine. Dans un pipeline, vous faites confiance au certificat vous-même, comme décrit dans Faire confiance au certificat racine de Dev Proxy.
--no-first-run Ignore l’assistant de premier lancement, qui n’est pas nécessaire sur un nouveau runner.
--no-watch Désactive automatiquement le redémarrage du proxy de développement lorsque son fichier de configuration change.

De plus, avant de démarrer Dev Proxy, définissez la variable d’environnement DEV_PROXY_API_TOKEN sur un jeton que vous générez. De cette façon, vous connaissez le jeton dont vous avez besoin pour appeler l’API Dev Proxy sans avoir à le récupérer à partir de Dev Proxy. Le jeton doit comporter au moins 32 caractères. Pour connaître les exigences complètes, consultez l’API proxy.

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

Les exemples de cet article utilisent ces options et la variable d’environnement DEV_PROXY_API_TOKEN .

Obtenir une configuration pour enregistrer les appels d’API

Si vous souhaitez enregistrer les API que votre application appelle pendant une exécution CI, vous n’avez pas besoin de générer une configuration à partir de zéro. Téléchargez le api-inventory préréglage à partir de la galerie d’exemples Dev Proxy à l’aide de la config get commande :

./devproxy/devproxy config get api-inventory

Le préréglage combine UrlDiscoveryPlugin et ExecutionSummaryPlugin avec les reporters et n’enregistre pas Dev Proxy comme proxy système. Lorsque vous démarrez Dev Proxy, passez le fichier de configuration du préréglage, remplacez les URL à surveiller par les API appelées par votre application et utilisez les indicateurs CI recommandés :

./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

Pour plus d’informations sur les paramètres prédéfinis, consultez Utiliser des configurations prédéfinies.

Démarrer le proxy de développement

Après avoir installé le proxy de développement, vous devez le démarrer. Lors du démarrage de Dev Proxy dans un pipeline CI/CD, il est important que ce démarrage s’effectue en arrière-plan. Sinon, votre pipeline sera bloqué jusqu’à ce que vous arrêtiez Dev Proxy.

Démarrez le proxy de développement en arrière-plan à l’aide des indicateurs CI recommandés :

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

Le proxy de développement imprime les informations de démarrage, notamment l’ID de processus (PID), l’URL du proxy, l’URL de l’API et le chemin du fichier journal :

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

Pour la sortie lisible par l’ordinateur, utilisez --output json pour obtenir JSONL :

./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"}

Conseil / Astuce

Utilisez --port 0 et --api-port 0 laissez le système d’exploitation attribuer des ports disponibles aléatoires. La sortie en mode détaché indique les ports réels affectés par le système d’exploitation, ce qui est utile dans les scénarios CI/CD pour éviter les conflits de ports. Lorsque vous utilisez des ports aléatoires, lisez l’URL du proxy et l’URL de l’API à partir de la sortie au lieu d’utiliser les URL par défaut http://127.0.0.1:8000 et http://127.0.0.1:8897, comme illustré dans l’exemple de script de démarrage.

Sinon, si vous utilisez un exécuteur Linux, vous pouvez démarrer le proxy de développement en arrière-plan à l’aide du contrôle de travail shell :

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

Attendez que le proxy de développement démarre

Lorsque vous démarrez Dev Proxy en arrière-plan, votre script continue immédiatement. Toutefois, le proxy de développement a besoin d’un certain temps pour démarrer. Pour vous assurer que Dev Proxy est prêt avant de commencer à envoyer des requêtes, attendez que son API réponde à une requête GET /proxy :

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

L’interrogation de l’API fonctionne quel que soit le port sur lequel le proxy de développement écoute, notamment lorsque vous utilisez --port 0.

Approuver le certificat racine de Dev Proxy

Après le démarrage de Dev Proxy, vous devez approuver son certificat racine avant d’envoyer des requêtes, car il utilise un certificat racine autosigné.

Selon vos autorisations, vous devrez peut-être créer le dossier ~/.config/dev-proxy/rootCert, dans lequel Dev Proxy stocke son certificat racine, avant de démarrer Dev Proxy :

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

Pour obtenir la clé publique du certificat racine, téléchargez-la à l’aide de Dev Proxy API. Si vous utilisez un runner basé sur Linux, vous pouvez installer le certificat en le copiant dans le magasin de certificats d’autorité de certification approuvés du système :

# 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

Configurer des variables d’environnement proxy

De nombreuses applications et bibliothèques utilisent les variables d’environnement http_proxy et https_proxy pour déterminer le serveur proxy à utiliser pour les requêtes HTTP et HTTPS. Étant donné que vous démarrez Dev Proxy avec --as-system-proxy false, vous devez définir ces variables d’environnement pour pointer vers l’instance Dev Proxy afin de vous assurer que votre application utilise Dev Proxy.

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

Gérer le Dev Proxy

Lorsque vous exécutez le proxy de développement dans un pipeline CI/CD, vous ne pouvez pas le contrôler de manière interactive. Au lieu de cela, vous pouvez le contrôler en envoyant des demandes à l’API proxy de développement.

Toutes les demandes d’API de Dev Proxy nécessitent un jeton Bearer dans l’en-tête Authorization. Si vous définissez la variable d’environnement DEV_PROXY_API_TOKEN comme recommandé, utilisez sa valeur. Sinon, comme Dev Proxy n’affiche pas le jeton au démarrage lorsque la variable d’environnement CI est définie, récupérez-le à l’aide de la commande api token :

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

Si vous souhaitez analyser les requêtes d’API envoyées par votre application, vous pouvez envoyer une requête POST au point de terminaison /proxy pour démarrer l’enregistrement :

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

Pour arrêter l’enregistrement, envoyez une POST demande au /proxy endpoint avec recording défini sur false:

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

Pour arrêter le proxy de développement, vous pouvez envoyer une POST requête au /proxy/stopproxy point de terminaison :

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

Après avoir arrêté le processus du proxy de développement, cela peut prendre un certain temps pour qu'il se ferme complètement. Pour vous assurer que Dev Proxy a terminé, attendez que son fichier journal, que Dev Proxy imprime lorsqu’il démarre en mode détaché, contienne l’un des messages d’achèvement, par exemple :

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

Lorsque tous les plug-ins d’enregistrement ont terminé leur exécution, le proxy de développement affiche le message DONE dans la sortie. S’il n’y avait aucune demande à traiter, le proxy de développement imprime le No requests to process message. Si une erreur s’est produite dans un plug-in, le proxy de développement imprime le An error occurred in a plugin message. Lorsque vous voyez l’un de ces messages, vous pouvez être sûr que le proxy de développement a terminé le traitement des demandes enregistrées.

Exemple de script de démarrage

Voici un exemple de script bash que vous pouvez utiliser pour démarrer Dev Proxy dans un pipeline CI/CD. Le script utilise les indicateurs CI recommandés, lit l’URL du proxy, l’URL de l’API et le chemin du fichier journal à partir de la sortie JSON, attend que l’API Dev Proxy réponde et fait confiance au certificat racine téléchargé à partir de l’API. Il utilise jq pour analyser la sortie JSON.

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

Voir aussi