ci: update examples to latest spec (#104)

Updates all Lua examples to use the verify-hello-app action, and the
correct environment variable names.

This allows the flag key/SDK key to be changed as necessary without any
hardcoding.

Author: cwaldren-ld

.github/actions/ci/action.yml

@@ -11,6 +11,9 @@ inputs:
   rockspec:
     description: 'The rockspec file for the server-side SDK.'
     required: true
+  aws-arn:
+    description: 'The AWS role ARN to use for verifying the example output'
+    required: true
 
 runs:
   using: composite
@@ -54,16 +57,18 @@ runs:
         LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib;./cpp-sdk/build-dynamic/release/lib
         LUA_INTERPRETER: ${{ contains(inputs.lua-version, 'jit') && 'luajit' || 'lua' }}
 
-    - name: Run hello-lua-server example
-      if: ${{ !contains(inputs.lua-version, 'jit') }}
+    - name: Copy get_from_env to directory above this
       shell: bash
       run: |
-        cd ./examples/hello-lua-server
-        lua hello.lua | tee output.txt
-        grep -F "is false for this user" output.txt || (echo "Expected false evaluation!" && exit 1)
+        cp -r ./examples/env-helper ../env-helper
+    - uses: launchdarkly/gh-actions/actions/verify-hello-app@verify-hello-app-v2.0.0
+      if: ${{ !contains(inputs.lua-version, 'jit') }}
+      name: 'Verify hello-lua-server example'
       env:
-        LD_SDK_KEY: "fake-sdk-key"
         # Needed because boost isn't installed in default system paths, which is
         # what the C++ Server-side SDK shared object expects.
         LD_LIBRARY_PATH: ${{ steps.install-boost.outputs.BOOST_ROOT }}/lib
-        LUA_INTERPRETER: ${{ contains(inputs.lua-version, 'jit') && 'luajit' || 'lua' }}
+      with:
+        use_server_key: true
+        role_arn: ${{ inputs.aws-arn }}
+        command: lua ./examples/hello-lua-server/hello.lua

.github/workflows/ci.yml

@@ -27,7 +27,9 @@ jobs:
   linux-build:
     needs: rockspecs
     runs-on: ubuntu-latest
-
+    permissions:
+      id-token: write
+      contents: read
     strategy:
       fail-fast: false
       matrix:
@@ -40,16 +42,18 @@ jobs:
         with:
           lua-version: ${{ matrix.version }}
           rockspec: ${{ matrix.package }}
+          aws-arn: ${{ vars.AWS_ROLE_ARN_EXAMPLES }}
 
 
   web-server-examples:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
     strategy:
       fail-fast: false
       matrix:
         name: ["hello-haproxy", "hello-nginx"]
-    env:
-      LD_SDK_KEY: foo
     steps:
       - uses: actions/checkout@v4
       - name: Get C++ Versions
@@ -60,25 +64,33 @@ jobs:
           docker build \
           --build-arg="CPP_SDK_VERSION=${{ steps.cpp-versions.outputs.sdk }}" \
           -t launchdarkly:${{ matrix.name }} -f ./examples/${{ matrix.name }}/Dockerfile .
-      - name: Run ${{ matrix.name }} container in background
-        run: |
-          docker run -dit --rm --name ${{ matrix.name }} -p 8123:80 --env LD_SDK_KEY="$LD_SDK_KEY" launchdarkly:${{ matrix.name }}
-      - name: Evaluate feature flag
-        run: |
-          curl --retry 5 --retry-all-errors --retry-delay 1 -s -v http://localhost:8123 | tee response.txt
-          grep -F "is false for this user" response.txt || (echo "Expected false evaluation!" && exit 1)
+
+      - uses: launchdarkly/gh-actions/actions/verify-hello-app@verify-hello-app-v2.0.0
+        name: 'Verify ${{ matrix.name}} example output'
+        with:
+          use_server_key: true
+          role_arn: ${{ vars.AWS_ROLE_ARN_EXAMPLES }}
+          command: |
+            docker run -dit --rm --name ${{ matrix.name }} -p 8123:80 \
+                      --env LAUNCHDARKLY_SDK_KEY="$LAUNCHDARKLY_SDK_KEY" \
+                      --env LAUNCHDARKLY_FLAG_KEY="$LAUNCHDARKLY_FLAG_KEY" \
+                      launchdarkly:${{ matrix.name }}
+                      curl --retry 5 --retry-all-errors --retry-delay 1 -s -v http://localhost:8123
+
       - name: Stop ${{ matrix.name }} container
         run: |
           docker stop ${{ matrix.name }}
 
+
   plain-lua-examples:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
     strategy:
       fail-fast: false
       matrix:
         name: [ "hello-debian"]
-    env:
-      LD_SDK_KEY: foo
     steps:
       - uses: actions/checkout@v4
       - name: Get C++ Versions
@@ -89,9 +101,13 @@ jobs:
           docker build \
           --build-arg="CPP_SDK_VERSION=${{ steps.cpp-versions.outputs.sdk }}" \
           -t launchdarkly:${{ matrix.name }} -f ./examples/${{ matrix.name }}/Dockerfile .
-      - name: Run ${{ matrix.name }} container in foreground
-        run: |
-          docker run --env LD_SDK_KEY="$LD_SDK_KEY" launchdarkly:${{ matrix.name }} > logs.txt
-      - name: Verify output
-        run: |
-          grep -F "is false for this user" logs.txt || (echo "Expected false evaluation!" && exit 1)
+      - uses: launchdarkly/gh-actions/actions/verify-hello-app@verify-hello-app-v2.0.0
+        name: 'Verify ${{ matrix.name}} example output'
+        with:
+          use_server_key: true
+          role_arn: ${{ vars.AWS_ROLE_ARN_EXAMPLES }}
+          command: |
+            docker run \
+            --env LAUNCHDARKLY_SDK_KEY="$LAUNCHDARKLY_SDK_KEY"  \
+            --env LAUNCHDARKLY_FLAG_KEY="$LAUNCHDARKLY_FLAG_KEY" \
+            launchdarkly:${{ matrix.name }}

.github/workflows/cpp-versions.yml

@@ -40,7 +40,7 @@ COPY launchdarkly-server-sdk.c .
 
 # The example expects to find the env-helper script up one directory, so preserve that structure
 # when copying. The purpose of env-helper is to allow the flag key & SDK keys to be injected via
-# environment variable (LD_SDK_KEY and LD_FLAG_KEY).
+# environment variable (LAUNCHDARKLY_SDK_KEY and LAUNCHDARKLY_FLAG_KEY).
 COPY ./examples/hello-debian/hello.lua hello-debian/
 COPY ./examples/env-helper env-helper
 

examples/hello-debian/Dockerfile

@@ -8,10 +8,10 @@ We've built a minimal dockerized example of using the Lua SDK within a Debian Bo
 `docker build -t hello-debian -f ./examples/hello-debian/Dockerfile .`.
 2. Run the demo with
     ```bash
-    docker run --rm --name hello-debian --env LD_SDK_KEY="my-sdk-key" --env LD_FLAG_KEY="my-boolean-flag" hello-debian
+    docker run --rm --name hello-debian --env LAUNCHDARKLY_SDK_KEY="my-sdk-key" --env LAUNCHDARKLY_FLAG_KEY="my-boolean-flag" hello-debian
     ```
-3. **Note:** the SDK key and flag key are passed with environment variables into the container. The `LD_FLAG_KEY` should be a boolean-type flag in your environment. If you don't pass 
-`LD_FLAG_KEY`, then the default flag key `my-boolean-flag` will be used.
+3. **Note:** the SDK key and flag key are passed with environment variables into the container. The `LAUNCHDARKLY_FLAG_KEY` should be a boolean-type flag in your environment. If you don't pass 
+`LAUNCHDARKLY_FLAG_KEY`, then the default flag key `my-boolean-flag` will be used.
 
 You should receive the message:
-> Feature flag is <true/false> for this user context
+> The (flag key) feature flag evaluates to (true/false).

examples/hello-debian/README.md

@@ -5,12 +5,12 @@ local get_from_env_or_default = dofile("../env-helper/get_from_env_or_default.lu
 local MY_SDK_KEY = ""
 
 -- Set MY_FLAG_KEY to the boolean-type feature flag key you want to evaluate.
-local MY_FLAG_KEY = "my-boolean-flag"
+local MY_FLAG_KEY = ""
 
 
 local config = {}
 
-local sdk_key = get_from_env_or_default("LD_SDK_KEY", MY_SDK_KEY)
+local sdk_key = get_from_env_or_default("LAUNCHDARKLY_SDK_KEY", MY_SDK_KEY)
 local client = ld.clientInit(sdk_key, 1000, config)
 
 local user = ld.makeContext({
@@ -20,6 +20,6 @@ local user = ld.makeContext({
     }
 })
 
-local flag_key = get_from_env_or_default("LD_FLAG_KEY", MY_FLAG_KEY)
+local flag_key = get_from_env_or_default("LAUNCHDARKLY_FLAG_KEY", MY_FLAG_KEY)
 local value = client:boolVariation(user, flag_key, false)
-print("Feature flag ".. flag_key .." is "..tostring(value).." for this user context")
+print("The ".. flag_key .." feature flag evaluates to "..tostring(value)..".")

examples/hello-debian/hello.lua

@@ -7,10 +7,10 @@ We've built a minimal dockerized example of using the Lua SDK with [HAProxy](htt
 1. On the command line from the **root** of the repo, build the image from this directory with `docker build -t hello-haproxy -f ./examples/hello-haproxy/Dockerfile .`.
 2. Run the demo with:  
     ```bash
-    docker run -it --rm --name hello-haproxy -p 8123:8123 --env LD_SDK_KEY="my-sdk-key" --env LD_FLAG_KEY="my-boolean-flag" hello-haproxy
+    docker run -it --rm --name hello-haproxy -p 8123:8123 --env LAUNCHDARKLY_SDK_KEY="my-sdk-key" --env LAUNCHDARKLY_FLAG_KEY="my-boolean-flag" hello-haproxy
     ```
-3. **Note:** the SDK key and flag key are passed with environment variables into the container. The `LD_FLAG_KEY` should be a boolean-type flag in your environment.
+3. **Note:** the SDK key and flag key are passed with environment variables into the container. The `LAUNCHDARKLY_FLAG_KEY` should be a boolean-type flag in your environment.
 4. Open `localhost:8123` in your browser. Toggle the flag on to see a change in the page (refresh the page.)
 
 You should receive the message: 
-> Feature flag is <true/false> for this user context
+> The (flag key) feature flag evaluates to (true/false).

examples/hello-haproxy/README.md

@@ -8,13 +8,13 @@ local get_from_env_or_default = require("get_from_env_or_default")
 local MY_SDK_KEY = ""
 
 -- Set MY_FLAG_KEY to the boolean-type feature flag key you want to evaluate.
-local MY_FLAG_KEY = "my-boolean-flag"
+local MY_FLAG_KEY = ""
 
 local config = {}
-local sdk_key = get_from_env_or_default("LD_SDK_KEY", MY_SDK_KEY)
+local sdk_key = get_from_env_or_default("LAUNCHDARKLY_SDK_KEY", MY_SDK_KEY)
 local client = ld.clientInit(sdk_key, 1000, config)
 
-local flag_key = get_from_env_or_default("LD_FLAG_KEY", MY_FLAG_KEY)
+local flag_key = get_from_env_or_default("LAUNCHDARKLY_FLAG_KEY", MY_FLAG_KEY)
 
 core.register_service("launchdarkly", "http", function(applet)
     applet:start_response()
@@ -26,9 +26,6 @@ core.register_service("launchdarkly", "http", function(applet)
         }
     })
 
-    if client:boolVariation(user, flag_key, false) then
-        applet:send("<p>Feature flag " .. flag_key .. " is true for this user context</p>")
-    else
-        applet:send("<p>Feature flag " .. flag_key .. " is false for this user context</p>")
-    end
+    local flag_value = client:boolVariation(user, flag_key, false)
+    applet:send("<p>The " .. flag_key .. " feature flag evaluates to " .. tostring(flag_value) .. ".</p>")
 end)

examples/hello-haproxy/service.lua

@@ -7,10 +7,10 @@ Then, use the Lua interpreter to run `hello.lua`:
 lua hello.lua
 ```
 
-If you'd rather use environment variables to specify the SDK key or flag key, set `LD_SDK_KEY` or `LD_FLAG_KEY`.
+If you'd rather use environment variables to specify the SDK key or flag key, set `LAUNCHDARKLY_SDK_KEY` or `LAUNCHDARKLY_FLAG_KEY`.
 ```bash
-LD_SDK_KEY=my-sdk-key LD_FLAG_KEY=my-boolean-flag lua hello.lua
+LAUNCHDARKLY_SDK_KEY=my-sdk-key LAUNCHDARKLY_FLAG_KEY=my-boolean-flag lua hello.lua
 ```
 
 The program should output:
-> Feature flag is <true/false> for this user context
+> The (flag key) feature flag evaluates to (true/false).

examples/hello-lua-server/README.md

@@ -5,12 +5,12 @@ local get_from_env_or_default = dofile("../env-helper/get_from_env_or_default.lu
 local MY_SDK_KEY = ""
 
 -- Set MY_FLAG_KEY to the boolean-type feature flag key you want to evaluate.
-local MY_FLAG_KEY = "my-boolean-flag"
+local MY_FLAG_KEY = ""
 
 
 local config = {}
 
-local sdk_key = get_from_env_or_default("LD_SDK_KEY", MY_SDK_KEY)
+local sdk_key = get_from_env_or_default("LAUNCHDARKLY_SDK_KEY", MY_SDK_KEY)
 local client = ld.clientInit(sdk_key, 1000, config)
 
 local user = ld.makeContext({
@@ -20,6 +20,6 @@ local user = ld.makeContext({
     }
 })
 
-local flag_key = get_from_env_or_default("LD_FLAG_KEY", MY_FLAG_KEY)
+local flag_key = get_from_env_or_default("LAUNCHDARKLY_FLAG_KEY", MY_FLAG_KEY)
 local value = client:boolVariation(user, flag_key, false)
-print("Feature flag ".. flag_key .." is "..tostring(value).." for this user context")
+print("The ".. flag_key .." feature flag evaluates to "..tostring(value)..".")