Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for other auth-schemes (i.e. Basic-Auth) #1507

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion cli/zally/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,19 @@ func CreateApp() *cli.App {
Value: "http://localhost:8000",
EnvVar: "ZALLY_URL",
},
cli.StringFlag{
Name: "auth-scheme, as",
Usage: "Scheme used for authentication `AUTH_SCHEME`",
EnvVar: "AUTH_SCHEME",
},
cli.StringFlag{
Name: "auth-params, ap",
Usage: "Parameters used for authentication `AUTH_PARAMS`",
EnvVar: "AUTH_PARAMS",
},
cli.StringFlag{
Name: "token, t",
Usage: "OAuth2 Token `OAUTH2_TOKEN`",
Usage: "OAuth2 Token (When set will overload auth-scheme and -params) `OAUTH2_TOKEN`",
EnvVar: "TOKEN",
},
cli.StringFlag{
Expand Down
14 changes: 12 additions & 2 deletions cli/zally/commands/lint.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,18 @@ func lint(c *cli.Context) error {
return domain.NewAppError(err, domain.ClientError)
}
skipSslVerification := c.Bool("skip-ssl-verification")
requestBuilder := utils.NewRequestBuilder(
c.GlobalString("linter-service"), c.GlobalString("token"), c.App)

var requestBuilder *utils.RequestBuilder

//If token is set, the Oauth2 auth-scheme will be used
if c.GlobalString("token") != "" {
requestBuilder = utils.NewRequestBuilder(
c.GlobalString("linter-service"), "Bearer", c.GlobalString("token"), c.App)
} else {
requestBuilder = utils.NewRequestBuilder(
c.GlobalString("linter-service"), c.GlobalString("auth-scheme"), c.GlobalString("auth-params"), c.App)
}

violations, err := doRequest(requestBuilder, data, skipSslVerification)
if err != nil {
return domain.NewAppError(err, domain.ServerError)
Expand Down
9 changes: 5 additions & 4 deletions cli/zally/commands/lint_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ package commands

import (
"flag"
"github.com/stretchr/testify/assert"
"io/ioutil"
"testing"
"time"

"github.com/stretchr/testify/assert"

"net/http"
"net/http/httptest"

Expand Down Expand Up @@ -61,7 +62,7 @@ func TestDoRequest(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
data, _ := readFile("testdata/minimal_swagger.json")

violations, err := doRequest(requestBuilder, data, false)
Expand All @@ -78,7 +79,7 @@ func TestDoRequest(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
data, _ := readFile("testdata/minimal_swagger.json")

violations, err := doRequest(requestBuilder, data, false)
Expand All @@ -96,7 +97,7 @@ func TestDoRequest(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
data, _ := readFile("testdata/minimal_swagger.json")

violations, err := doRequest(requestBuilder, data, false)
Expand Down
13 changes: 11 additions & 2 deletions cli/zally/commands/supported_rules.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,17 @@ func listRules(c *cli.Context) error {
return domain.NewAppError(err, domain.ClientError)
}

requestBuilder := utils.NewRequestBuilder(
c.GlobalString("linter-service"), c.GlobalString("token"), c.App)
var requestBuilder *utils.RequestBuilder

//If token is set, the Oauth2 auth-scheme will be used
if c.GlobalString("token") != "" {
requestBuilder = utils.NewRequestBuilder(
c.GlobalString("linter-service"), "Bearer", c.GlobalString("token"), c.App)
} else {
requestBuilder = utils.NewRequestBuilder(
c.GlobalString("linter-service"), c.GlobalString("auth-scheme"), c.GlobalString("auth-params"), c.App)
}

rules, err := fetchRules(requestBuilder, ruleType, c.Bool("skip-ssl-verification"))
if err != nil {
return domain.NewAppError(err, domain.ServerError)
Expand Down
9 changes: 5 additions & 4 deletions cli/zally/commands/supported_rules_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@ package commands

import (
"bytes"
"github.com/stretchr/testify/assert"
"io"
"io/ioutil"
"net/http"
"net/http/httptest"
"os"
"testing"

"github.com/stretchr/testify/assert"

"github.com/zalando/zally/cli/zally/utils/formatters"

"fmt"
Expand Down Expand Up @@ -69,7 +70,7 @@ func TestFetchRules(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
rules, err := fetchRules(requestBuilder, "", false)

tests.AssertEquals(t, nil, err)
Expand All @@ -89,7 +90,7 @@ func TestFetchRules(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
rules, err := fetchRules(requestBuilder, "", false)

tests.AssertEquals(t, "Cannot submit file for linting. HTTP Status: 400, Response: Something went wrong", err.Error())
Expand All @@ -106,7 +107,7 @@ func TestFetchRules(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(handler))
defer testServer.Close()

requestBuilder := utils.NewRequestBuilder(testServer.URL, "", app)
requestBuilder := utils.NewRequestBuilder(testServer.URL, "Bearer", "", app)
fetchRules(requestBuilder, "must", false)
})
}
Expand Down
19 changes: 11 additions & 8 deletions cli/zally/utils/request_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,27 @@ package utils

import (
"fmt"
"github.com/urfave/cli"
"io"
"net/http"
"net/url"

"github.com/urfave/cli"
)

// RequestBuilder builds Zally specific requests
type RequestBuilder struct {
baseURL string
token string
userAgent string
baseURL string
authScheme string
authParameters string
userAgent string
}

// NewRequestBuilder creates an instance of RequestBuilder
func NewRequestBuilder(baseURL string, token string, app *cli.App) *RequestBuilder {
func NewRequestBuilder(baseURL string, authScheme string, authParameters string, app *cli.App) *RequestBuilder {
var builder RequestBuilder
builder.baseURL = baseURL
builder.token = token
builder.authScheme = authScheme
builder.authParameters = authParameters
builder.userAgent = fmt.Sprintf("%s/%s", app.Name, app.Version)
return &builder
}
Expand All @@ -39,8 +42,8 @@ func (r *RequestBuilder) Build(httpVerb string, uri string, body io.Reader) (*ht
request.Header.Add("Content-Type", "application/json")
request.Header.Add("User-Agent", r.userAgent)

if len(r.token) > 0 {
request.Header.Add("Authorization", fmt.Sprintf("Bearer %s", r.token))
if len(r.authParameters) > 0 {
request.Header.Add("Authorization", fmt.Sprintf("%s %s", r.authScheme, r.authParameters))
}

return request, nil
Expand Down
16 changes: 8 additions & 8 deletions cli/zally/utils/request_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ var app = cli.NewApp()

func TestNewRequestBuilder(t *testing.T) {
t.Run("accepts_base_url_and_token", func(t *testing.T) {
builder := NewRequestBuilder("http://example.com", "some_token", app)
builder := NewRequestBuilder("http://example.com", "Bearer", "some_token", app)

tests.AssertEquals(t, "http://example.com", builder.baseURL)
tests.AssertEquals(t, "some_token", builder.token)
tests.AssertEquals(t, "some_token", builder.authParameters)
})
}

func TestRequestBuilderBuild(t *testing.T) {
t.Run("creates_absolute_url", func(t *testing.T) {
builder := NewRequestBuilder("http://example.com/base", "some_token", app)
builder := NewRequestBuilder("http://example.com/base", "Bearer", "some_token", app)
request, err := builder.Build("GET", "/my-path?abcd=efgh", nil)

tests.AssertEquals(t, "http://example.com/base/my-path?abcd=efgh", request.URL.String())
tests.AssertEquals(t, nil, err)
})

t.Run("adds_auth_header_when_token_is_specified", func(t *testing.T) {
builder := NewRequestBuilder("http://example.com/", "some_token", app)
builder := NewRequestBuilder("http://example.com/", "Bearer", "some_token", app)
request, err := builder.Build("GET", "/my-path", nil)

tests.AssertEquals(t, "Bearer some_token", request.Header.Get("Authorization"))
Expand All @@ -39,23 +39,23 @@ func TestRequestBuilderBuild(t *testing.T) {
t.Run("adds_user_agent_with_app_name_and_version_header", func(t *testing.T) {
app.Name = "Zally-CLI"
app.Version = "1.1"
builder := NewRequestBuilder("http://example.com/", "", app)
builder := NewRequestBuilder("http://example.com/", "Bearer", "", app)
request, err := builder.Build("GET", "/my-path", nil)

tests.AssertEquals(t, "Zally-CLI/1.1", request.Header.Get("User-Agent"))
tests.AssertEquals(t, nil, err)
})

t.Run("adds_no_auth_header_when_token_is_not_specified", func(t *testing.T) {
builder := NewRequestBuilder("http://example.com/", "", app)
builder := NewRequestBuilder("http://example.com/", "Bearer", "", app)
request, err := builder.Build("GET", "/my-path", nil)

tests.AssertEquals(t, "", request.Header.Get("Authorization"))
tests.AssertEquals(t, nil, err)
})

t.Run("sets_proper_http_method", func(t *testing.T) {
builder := NewRequestBuilder("http://example.com/", "some_token", app)
builder := NewRequestBuilder("http://example.com/", "Bearer", "some_token", app)
request, err := builder.Build("HEAD", "/my-path", nil)

tests.AssertEquals(t, "HEAD", request.Method)
Expand All @@ -64,7 +64,7 @@ func TestRequestBuilderBuild(t *testing.T) {

t.Run("sets_proper_body", func(t *testing.T) {
body := []byte("Test body")
builder := NewRequestBuilder("http://example.com/", "some_token", app)
builder := NewRequestBuilder("http://example.com/", "Bearer", "some_token", app)
request, err := builder.Build("POST", "/my-path", bytes.NewBuffer(body))

reader, err := request.GetBody()
Expand Down