boundary/internal/auth/oidc/options_test.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

package oidc

import (
	"crypto/x509"
	"net/url"
	"testing"

	"github.com/hashicorp/boundary/internal/db"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// Test_GetOpts provides unit tests for GetOpts and all the options
func Test_GetOpts(t *testing.T) {
	t.Parallel()
	t.Run("WithName", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithName("test"))
		testOpts := getDefaultOptions()
		testOpts.withName = "test"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithDescription", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithDescription("test desc"))
		testOpts := getDefaultOptions()
		testOpts.withDescription = "test desc"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithLimit", func(t *testing.T) {
		assert := assert.New(t)
		// test default of 0
		opts := getOpts()
		testOpts := getDefaultOptions()
		testOpts.withLimit = 0
		assert.Equal(opts, testOpts)

		opts = getOpts(WithLimit(-1))
		testOpts = getDefaultOptions()
		testOpts.withLimit = -1
		assert.Equal(opts, testOpts)

		opts = getOpts(WithLimit(1))
		testOpts = getDefaultOptions()
		testOpts.withLimit = 1
		assert.Equal(opts, testOpts)
	})
	t.Run("WithMaxAge", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithMaxAge(1000))
		testOpts := getDefaultOptions()
		testOpts.withMaxAge = 1000
		assert.Equal(opts, testOpts)
	})
	t.Run("WithApiUrl", func(t *testing.T) {
		assert := assert.New(t)
		u := TestConvertToUrls(t, "https://alice.com")[0]
		opts := getOpts(WithApiUrl(u))
		testOpts := getDefaultOptions()
		testOpts.withApiUrl = u
		assert.Equal(opts, testOpts)
	})
	t.Run("WithCertificates", func(t *testing.T) {
		assert := assert.New(t)
		testCert, _ := testGenerateCA(t, "localhost")
		testCert2, _ := testGenerateCA(t, "127.0.0.1")

		opts := getOpts(WithCertificates(testCert, testCert2))
		testOpts := getDefaultOptions()
		testOpts.withCertificates = []*x509.Certificate{testCert, testCert2}
		assert.Equal(opts, testOpts)
	})
	t.Run("WithAudClaims", func(t *testing.T) {
		assert := assert.New(t)
		aud := []string{"alice.com", "eve.com", "bob.com"}
		opts := getOpts(WithAudClaims(aud...))
		testOpts := getDefaultOptions()
		testOpts.withAudClaims = aud
		assert.Equal(opts, testOpts)
	})
	t.Run("WithSigningAlgs", func(t *testing.T) {
		assert := assert.New(t)
		algs := []Alg{RS256, RS384, RS512}
		opts := getOpts(WithSigningAlgs(algs...))
		testOpts := getDefaultOptions()
		testOpts.withSigningAlgs = algs
		assert.Equal(opts, testOpts)
	})
	t.Run("WithClaimsScopes", func(t *testing.T) {
		assert := assert.New(t)
		scopes := []string{"email", "profile"}
		opts := getOpts(WithClaimsScopes(scopes...))
		testOpts := getDefaultOptions()
		testOpts.withClaimsScopes = scopes
		assert.Equal(opts, testOpts)
	})
	t.Run("WithEmail", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithEmail("bob@alice.com"))
		testOpts := getDefaultOptions()
		testOpts.withEmail = "bob@alice.com"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithFullName", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithFullName("Bob Eve Alice"))
		testOpts := getDefaultOptions()
		testOpts.withFullName = "Bob Eve Alice"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithOrderByCreateTime", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithOrderByCreateTime(true))
		testOpts := getDefaultOptions()
		testOpts.withOrderByCreateTime = true
		testOpts.ascending = true
		assert.Equal(opts, testOpts)
	})
	t.Run("WithUnauthenticatedUser", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithUnauthenticatedUser(true))
		testOpts := getDefaultOptions()
		testOpts.withUnauthenticatedUser = true
		assert.Equal(opts, testOpts)
	})
	t.Run("WithForce", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithForce())
		testOpts := getDefaultOptions()
		testOpts.withForce = true
		assert.Equal(opts, testOpts)
	})
	t.Run("WithDryRun", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithDryRun())
		testOpts := getDefaultOptions()
		testOpts.withDryRun = true
		assert.Equal(opts, testOpts)
	})
	t.Run("WithAuthMethod", func(t *testing.T) {
		assert := assert.New(t)
		am := AllocAuthMethod()
		am.PublicId = "alice's-auth-method"
		opts := getOpts(WithAuthMethod(&am))
		testOpts := getDefaultOptions()
		testOpts.withAuthMethod = &am
		assert.Equal(opts, testOpts)
	})
	t.Run("WithPublicId", func(t *testing.T) {
		assert := assert.New(t)
		id := "alice's-auth-method"
		opts := getOpts(WithPublicId(id))
		testOpts := getDefaultOptions()
		testOpts.withPublicId = id
		assert.Equal(opts, testOpts)
	})
	t.Run("WithRoundtripPayload", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithRoundtripPayload("payload"))
		testOpts := getDefaultOptions()
		testOpts.withRoundtripPayload = "payload"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithKeyId", func(t *testing.T) {
		assert := assert.New(t)
		opts := getOpts(WithKeyId("specific_id"))
		testOpts := getDefaultOptions()
		testOpts.withKeyId = "specific_id"
		assert.Equal(opts, testOpts)
	})
	t.Run("WithIssuer", func(t *testing.T) {
		assert := assert.New(t)
		u, err := url.Parse("http://test.com")
		require.NoError(t, err)
		opts := getOpts(WithIssuer(u))
		testOpts := getDefaultOptions()
		testOpts.withIssuer = u
		assert.Equal(opts, testOpts)
	})
	t.Run("WithOperationalState", func(t *testing.T) {
		assert := assert.New(t)
		testOpts := getDefaultOptions()
		assert.Equal(InactiveState, testOpts.withOperationalState)
		opts := getOpts(WithOperationalState(ActivePublicState))
		assert.Equal(ActivePublicState, opts.withOperationalState)
	})
	t.Run("WithAccountClaimMap", func(t *testing.T) {
		assert := assert.New(t)
		acm := map[string]AccountToClaim{
			"oid":          ToSubClaim,
			"display_name": ToNameClaim,
		}
		opts := getOpts(WithAccountClaimMap(acm))
		testOpts := getDefaultOptions()
		testOpts.withAccountClaimMap = acm
		assert.Equal(opts, testOpts)
	})
	t.Run("WithReader", func(t *testing.T) {
		assert := assert.New(t)
		testOpts := getDefaultOptions()
		assert.Nil(testOpts.withReader)
		var r db.Reader
		opts := getOpts(WithReader(r))
		assert.Equal(r, opts.withReader)
	})
}