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

Fix secret priority #2599

Merged
merged 5 commits into from
Oct 16, 2023
Merged
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
13 changes: 11 additions & 2 deletions docs/docs/20-usage/40-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ Woodpecker provides the ability to store named parameters external to the YAML c

Secrets are exposed to your pipeline steps and plugins as uppercase environment variables and can therefore be referenced in the commands section of your pipeline.

Woodpecker provides three different levels to add secrets to your pipeline. The following list shows the priority of the different levels. If a secret is defined in multiple levels, will be used following this priorities: Repository secrets > Organization secrets > Global secrets.

1. **Repository secrets**: They are available to all pipelines of an repository.
2. **Organization secrets**: They are available to all pipelines of an organization.
3. **Global secrets**: Can be configured by an instance admin.
They are available to all pipelines of the **whole** Woodpecker instance and should therefore **only** be used for secrets that are allowed to be read by **all** users.

## Usage

```diff
steps:
docker:
Expand Down Expand Up @@ -45,7 +54,7 @@ steps:

## Adding Secrets

Secrets are added to the Woodpecker secret store on the UI or with the CLI.
Secrets are added to the Woodpecker in the UI or with the CLI.

## Alternate Names

Expand Down Expand Up @@ -88,7 +97,7 @@ If you enable the option "Only available for plugins", always set an image filte
If you only set an image filter, you could still access the secret using the same image and by specifying a command that prints it.
:::

## Examples
## CLI Examples

Create the secret using default settings. The secret will be available to all images in your pipeline, and will be available to all push, tag, and deployment events (not pull request events).

Expand Down
2 changes: 1 addition & 1 deletion server/plugins/secrets/builtin.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func (b *builtin) SecretListPipeline(repo *model.Repo, _ *model.Pipeline, p *mod
{Global: true},
} {
for _, secret := range s {
if secret.Global() == cond.Global && secret.Organization() == cond.Organization {
if secret.Global() != cond.Global || secret.Organization() != cond.Organization {
continue
}
if _, ok := uniq[secret.Name]; ok {
Expand Down
100 changes: 100 additions & 0 deletions server/plugins/secrets/builtin_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Copyright 2023 Woodpecker Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package secrets_test

import (
"context"
"testing"

"github.com/franela/goblin"
"github.com/stretchr/testify/mock"
"github.com/woodpecker-ci/woodpecker/server/model"
"github.com/woodpecker-ci/woodpecker/server/plugins/secrets"
mocks_store "github.com/woodpecker-ci/woodpecker/server/store/mocks"
)

func TestSecretListPipeline(t *testing.T) {
g := goblin.Goblin(t)
ctx := context.Background()
mockStore := mocks_store.NewStore(t)

// global secret
globalSecret := &model.Secret{
ID: 1,
OrgID: 0,
RepoID: 0,
Name: "secret",
Value: "value-global",
}

// org secret
orgSecret := &model.Secret{
ID: 2,
OrgID: 1,
RepoID: 0,
Name: "secret",
Value: "value-org",
}

// repo secret
repoSecret := &model.Secret{
ID: 3,
OrgID: 1,
RepoID: 1,
Name: "secret",
Value: "value-repo",
}

g.Describe("Priority of secrets", func() {
g.It("should get the repo secret", func() {
mockStore.On("SecretList", mock.Anything, mock.Anything, mock.Anything).Once().Return([]*model.Secret{
globalSecret,
orgSecret,
repoSecret,
}, nil)

s, err := secrets.New(ctx, mockStore).SecretListPipeline(&model.Repo{}, &model.Pipeline{}, &model.ListOptions{})
g.Assert(err).IsNil()

g.Assert(len(s)).Equal(1)
g.Assert(s[0].Value).Equal("value-repo")
})

g.It("should get the org secret", func() {
mockStore.On("SecretList", mock.Anything, mock.Anything, mock.Anything).Once().Return([]*model.Secret{
globalSecret,
orgSecret,
}, nil)

s, err := secrets.New(ctx, mockStore).SecretListPipeline(&model.Repo{}, &model.Pipeline{}, &model.ListOptions{})
g.Assert(err).IsNil()

g.Assert(len(s)).Equal(1)
g.Assert(s[0].Value).Equal("value-org")
})

g.It("should get the global secret", func() {
mockStore.On("SecretList", mock.Anything, mock.Anything, mock.Anything).Once().Return([]*model.Secret{
globalSecret,
}, nil)

s, err := secrets.New(ctx, mockStore).SecretListPipeline(&model.Repo{}, &model.Pipeline{}, &model.ListOptions{})
g.Assert(err).IsNil()

g.Assert(len(s)).Equal(1)
g.Assert(s[0].Value).Equal("value-global")
})
})
}