Skip to content

Commit

Permalink
add github action to run make test
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 committed Sep 6, 2023
1 parent 81a1728 commit 3a8fd81
Show file tree
Hide file tree
Showing 8 changed files with 229 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
2 changes: 2 additions & 0 deletions pkg/plugins/golang/v4/scaffolds/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package scaffolds
import (
log "github.com/sirupsen/logrus"
"github.com/spf13/afero"
"sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v4/scaffolds/internal/templates/workflows"

"sigs.k8s.io/kubebuilder/v3/pkg/config"
"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
Expand Down Expand Up @@ -139,5 +140,6 @@ func (s *initScaffolder) Scaffold() error {
&templates.Dockerfile{},
&templates.DockerIgnore{},
&templates.Readme{},
&workflows.UnitTest{},
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
Copyright 2023 The Kubernetes 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 workflows

import (
"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
)

var _ machinery.Template = &UnitTest{}

// UnitTest scaffolds a file that defines Golangci GitHub Actions
type UnitTest struct {
machinery.TemplateMixin
machinery.ProjectNameMixin
}

// SetTemplateDefaults implements file.Template
func (f *UnitTest) SetTemplateDefaults() error {
if f.Path == "" {
f.Path = ".workflows/unit-test.yml"
}

f.TemplateBody = golangciGitHubActionTemplate

f.IfExistsAction = machinery.SkipFile

return nil
}

//nolint:lll
const golangciGitHubActionTemplate = `name: Unit tests
# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:
jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
`
26 changes: 26 additions & 0 deletions testdata/project-v4-multigroup/.workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
26 changes: 26 additions & 0 deletions testdata/project-v4-with-deploy-image/.workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
26 changes: 26 additions & 0 deletions testdata/project-v4-with-grafana/.workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test
26 changes: 26 additions & 0 deletions testdata/project-v4/.workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Unit tests

# Trigger the workflow on pull requests and direct pushes to any branch
on:
push:
pull_request:

jobs:
test:
name: Test
runs-on: ubuntu-latest
# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
steps:
- name: Clone the code
uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '~1.20'
# This step is needed as the following one tries to remove
# kustomize for each test but has no permission to do so
- name: Remove pre-installed kustomize
run: sudo rm -f /usr/local/bin/kustomize
- name: Perform the test
run: make test

0 comments on commit 3a8fd81

Please sign in to comment.