Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Send authenticated SMS in e2e-runner #1839

Merged
merged 4 commits into from
Feb 17, 2021
Merged

Conversation

sethvargo
Copy link
Member

@sethvargo sethvargo commented Feb 17, 2021

This updates the e2e-runner to send an SMS credential as part of its test. This feature is on by default, but it can be disabled by setting E2E_SKIP_SMS to any truthy value on the e2e-runner service.

Operators must configure the e2e realm with Twilio Test Credentials via the verification server UI. Note that the system will not actually send an SMS, it uses Twilio's magic numbers and test credentials to simulate all aspects of the system and API calls but stops short of actually delivering an SMS.

Fixes #1832

Release Note

Simulate sending SMS in e2e-runner and enable authenticated SMS for the e2e test realm. Operators will either need to opt out of the e2e-runner service testing SMS paths by setting `E2E_SKIP_SMS` (not recommended) or configure the e2e test realm with [Twilio Test Credentials](https://www.twilio.com/docs/iam/test-credentials). See the updated production guide for screenshots and examples. We recommend configuring the e2e-test-realm _before_ upgrading the service to minimize alerts.

@google-cla google-cla bot added the cla: yes Auto: added by CLA bot when all committers have signed a CLA. label Feb 17, 2021
cmd/e2e-runner/main.go Show resolved Hide resolved
internal/clients/e2e.go Outdated Show resolved Hide resolved
internal/envstest/bootstrap.go Outdated Show resolved Hide resolved
This updates the e2e-runner to send an SMS credential as part of its test. This feature is on by default, but it can be disabled by setting `E2E_SKIP_SMS` to any truthy value on the e2e-runner service.

Operators must configure the e2e realm with [Twilio Test Credentials](https://www.twilio.com/docs/iam/test-credentials) via the verification server UI. Note that the system will not actually send an SMS, it uses Twilio's magic numbers and test credentials to simulate all aspects of the system and API calls but stops short of actually delivering an SMS.
mikehelmick
mikehelmick previously approved these changes Feb 17, 2021
@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikehelmick, sethvargo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [mikehelmick,sethvargo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-robot google-oss-robot merged commit 6ddae22 into main Feb 17, 2021
@google-oss-robot google-oss-robot deleted the sethvargo/sms_e2e branch February 17, 2021 20:20
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes Auto: added by CLA bot when all committers have signed a CLA.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable authenticated SMS in E2E runner
3 participants