Skip to content

Add Service Banners #5272

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

Merged
merged 20 commits into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Finish backend
  • Loading branch information
ammario committed Dec 3, 2022
commit afd8fb98030f1a9bac5d98ec49f64644608e44e7
2 changes: 1 addition & 1 deletion coderd/database/databasefake/databasefake.go
Original file line number Diff line number Diff line change
Expand Up @@ -3308,7 +3308,7 @@ func (q *fakeQuerier) GetServiceBanner(_ context.Context) (string, error) {
return "", sql.ErrNoRows
}

return string(q.lastUpdateCheck), nil
return string(q.serviceBanner), nil
}

func (q *fakeQuerier) InsertLicense(
Expand Down
31 changes: 31 additions & 0 deletions codersdk/servicebanner.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
package codersdk

import (
"context"
"encoding/json"
"net/http"
)

type ServiceBanner struct {
Enabled bool `json:"enabled"`
Message string `json:"message,omitempty"`
BackgroundColor string `json:"background_color,omitempty"`
}

func (c *Client) ServiceBanner(ctx context.Context) (*ServiceBanner, error) {
res, err := c.Request(ctx, http.MethodGet, "/api/v2/service-banner", nil)
if err != nil {
return nil, err
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return nil, readBodyAsError(res)
}
var b ServiceBanner
return &b, json.NewDecoder(res.Body).Decode(&b)
}

func (c *Client) SetServiceBanner(ctx context.Context, s *ServiceBanner) error {
res, err := c.Request(ctx, http.MethodPut, "/api/v2/service-banner", s)
if err != nil {
return err
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return readBodyAsError(res)
}
return nil
}
12 changes: 11 additions & 1 deletion enterprise/coderd/servicebanner.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"net/http"

"github.com/coder/coder/coderd/httpapi"
"github.com/coder/coder/coderd/rbac"
"github.com/coder/coder/codersdk"
)

Expand Down Expand Up @@ -42,7 +43,9 @@ func (api *API) serviceBanner(rw http.ResponseWriter, r *http.Request) {
err = json.Unmarshal([]byte(serviceBannerJSON), &serviceBanner)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: fmt.Sprintf("unmarshal json: %+v", err),
Message: fmt.Sprintf(
"unmarshal json: %+v, raw: %s", err, serviceBannerJSON,
),
})
return
}
Expand All @@ -53,6 +56,13 @@ func (api *API) serviceBanner(rw http.ResponseWriter, r *http.Request) {
func (api *API) putServiceBanner(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()

if !api.AGPL.Authorize(r, rbac.ActionUpdate, rbac.ResourceDeploymentConfig) {
httpapi.Write(ctx, rw, http.StatusForbidden, codersdk.Response{
Message: "Insufficient permissions to update service banner",
})
return
}

var serviceBanner codersdk.ServiceBanner
if !httpapi.Read(ctx, rw, r, &serviceBanner) {
return
Expand Down
42 changes: 39 additions & 3 deletions enterprise/coderd/servicebanner_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@ package coderd_test

import (
"context"
"errors"
"net/http"
"testing"

"github.com/stretchr/testify/require"

"github.com/coder/coder/coderd/coderdtest"
"github.com/coder/coder/codersdk"
"github.com/coder/coder/enterprise/coderd/coderdenttest"
"github.com/coder/coder/testutil"
)
Expand All @@ -15,10 +20,41 @@ func TestServiceBanners(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

client := coderdenttest.New(t, &coderdenttest.Options{})
adminClient := coderdenttest.New(t, &coderdenttest.Options{})

adminUser := coderdtest.CreateFirstUser(t, adminClient)

user := coderdtest.CreateFirstUser(t, client)
coderdenttest.AddLicense(t, client, coderdenttest.LicenseOptions{
// Even without a license, the banner should return as disabled.
sb, err := adminClient.ServiceBanner(ctx)
require.NoError(t, err)
require.False(t, sb.Enabled)

coderdenttest.AddLicense(t, adminClient, coderdenttest.LicenseOptions{
ServiceBanners: true,
})

// Default state
sb, err = adminClient.ServiceBanner(ctx)
require.NoError(t, err)
require.False(t, sb.Enabled)

basicUserClient := coderdtest.CreateAnotherUser(t, adminClient, adminUser.OrganizationID)

// Regular user should be unable to set the banner
sb.Enabled = true
err = basicUserClient.SetServiceBanner(ctx, sb)
require.Error(t, err)
var sdkError *codersdk.Error
require.True(t, errors.As(err, &sdkError))
require.Equal(t, http.StatusForbidden, sdkError.StatusCode())

// But an admin can
wantBanner := sb
wantBanner.Enabled = true
wantBanner.Message = "Hey"
err = adminClient.SetServiceBanner(ctx, wantBanner)
require.NoError(t, err)
gotBanner, err := adminClient.ServiceBanner(ctx)
require.NoError(t, err)
require.Equal(t, wantBanner, gotBanner)
}