|
| 1 | +#!/usr/bin/env -S npm run tsn -T |
| 2 | + |
| 3 | +/** |
| 4 | +--- |
| 5 | +title: Secrets with Devbox (Create, Inject, Verify, Delete) |
| 6 | +slug: secrets-with-devbox |
| 7 | +use_case: Create a secret, inject it into a devbox as an environment variable, verify access, and clean up. |
| 8 | +workflow: |
| 9 | + - Create a secret with a test value |
| 10 | + - Create a devbox with the secret mapped to an env var |
| 11 | + - Execute a command that reads the secret from the environment |
| 12 | + - Verify the value matches |
| 13 | + - Shutdown devbox and delete secret |
| 14 | +tags: |
| 15 | + - secrets |
| 16 | + - devbox |
| 17 | + - environment-variables |
| 18 | + - cleanup |
| 19 | +prerequisites: |
| 20 | + - RUNLOOP_API_KEY |
| 21 | +run: yarn tsn -T examples/secrets-with-devbox.ts |
| 22 | +test: yarn test:examples |
| 23 | +--- |
| 24 | +*/ |
| 25 | + |
| 26 | +import { RunloopSDK } from '@runloop/api-client'; |
| 27 | +import { wrapRecipe, runAsCli } from './_harness'; |
| 28 | +import type { RecipeContext, RecipeOutput } from './types'; |
| 29 | + |
| 30 | +export async function recipe(ctx: RecipeContext): Promise<RecipeOutput> { |
| 31 | + const { cleanup } = ctx; |
| 32 | + |
| 33 | + const sdk = new RunloopSDK({ |
| 34 | + bearerToken: process.env['RUNLOOP_API_KEY'], |
| 35 | + }); |
| 36 | + |
| 37 | + const secretName = 'RUNLOOP_SECRET_EXAMPLE'; |
| 38 | + const secretValue = 'my-secret-value'; |
| 39 | + |
| 40 | + const secret = await sdk.secret.create({ |
| 41 | + name: secretName, |
| 42 | + value: secretValue, |
| 43 | + }); |
| 44 | + cleanup.add(`secret:${secretName}`, () => secret.delete()); |
| 45 | + |
| 46 | + const devbox = await sdk.devbox.create({ |
| 47 | + name: 'secrets-example-devbox', |
| 48 | + secrets: { |
| 49 | + MY_SECRET_ENV: secret, |
| 50 | + }, |
| 51 | + launch_parameters: { |
| 52 | + resource_size_request: 'X_SMALL', |
| 53 | + keep_alive_time_seconds: 60 * 5, |
| 54 | + }, |
| 55 | + }); |
| 56 | + cleanup.add(`devbox:${devbox.id}`, () => sdk.devbox.fromId(devbox.id).shutdown()); |
| 57 | + |
| 58 | + const result = await devbox.cmd.exec('echo $MY_SECRET_ENV'); |
| 59 | + const stdout = await result.stdout(); |
| 60 | + |
| 61 | + const updatedSecret = await sdk.secret.update(secret, { |
| 62 | + value: 'updated-secret-value', |
| 63 | + }); |
| 64 | + |
| 65 | + const secrets = await sdk.secret.list(); |
| 66 | + const foundSecret = secrets.find((s) => s.name === secretName); |
| 67 | + |
| 68 | + const secretInfo = await secret.getInfo(); |
| 69 | + const updatedInfo = await updatedSecret.getInfo(); |
| 70 | + |
| 71 | + return { |
| 72 | + resourcesCreated: [`secret:${secretName}`, `devbox:${devbox.id}`], |
| 73 | + checks: [ |
| 74 | + { |
| 75 | + name: 'secret created successfully', |
| 76 | + passed: secret.name === secretName && secretInfo.id.startsWith('sec_'), |
| 77 | + details: `name=${secret.name}, id=${secretInfo.id}`, |
| 78 | + }, |
| 79 | + { |
| 80 | + name: 'devbox can read secret as env var', |
| 81 | + passed: result.exitCode === 0 && stdout.trim() === secretValue, |
| 82 | + details: `exitCode=${result.exitCode}, stdout="${stdout.trim()}"`, |
| 83 | + }, |
| 84 | + { |
| 85 | + name: 'secret updated successfully', |
| 86 | + passed: updatedSecret.name === secretName, |
| 87 | + details: `update_time_ms=${updatedInfo.update_time_ms}`, |
| 88 | + }, |
| 89 | + { |
| 90 | + name: 'secret appears in list', |
| 91 | + passed: foundSecret !== undefined && foundSecret.name === secretName, |
| 92 | + details: foundSecret ? `found name=${foundSecret.name}` : 'not found', |
| 93 | + }, |
| 94 | + ], |
| 95 | + }; |
| 96 | +} |
| 97 | + |
| 98 | +export const runSecretsWithDevboxExample = wrapRecipe({ recipe }); |
| 99 | + |
| 100 | +if (require.main === module) { |
| 101 | + void runAsCli(runSecretsWithDevboxExample); |
| 102 | +} |
0 commit comments