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

⚠️ Remove deprecated pkg/runtime/log package and utils #1105

Merged
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
2 changes: 1 addition & 1 deletion examples/builtins/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import (
var log = logf.Log.WithName("example-controller")

func main() {
logf.SetLogger(zap.Logger(false))
logf.SetLogger(zap.New())
entryLog := log.WithName("entrypoint")

// Setup a Manager
Expand Down
2 changes: 1 addition & 1 deletion examples/crd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ func (r *reconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
}

func main() {
ctrl.SetLogger(zap.Logger(true))
ctrl.SetLogger(zap.New())

mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{})
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion examples/crd/pkg/groupversion_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ package pkg

import (
"k8s.io/apimachinery/pkg/runtime/schema"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/scheme"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/builder/builder_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var testenv *envtest.Environment
var cfg *rest.Config

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}
addCRDToEnvironment(testenv,
Expand Down
2 changes: 1 addition & 1 deletion pkg/cache/cache_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
2 changes: 1 addition & 1 deletion pkg/client/apiutil/apiutil_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func TestSource(t *testing.T) {
var cfg *rest.Config

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

// for things that technically need a rest.Config for defaulting, but don't actually use them
cfg = &rest.Config{}
Expand Down
2 changes: 1 addition & 1 deletion pkg/client/client_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
2 changes: 1 addition & 1 deletion pkg/client/config/config_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestConfig(t *testing.T) {
}

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

close(done)
}, 60)
2 changes: 1 addition & 1 deletion pkg/client/fake/client_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ func TestSource(t *testing.T) {
}

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
close(done)
}, 60)
2 changes: 1 addition & 1 deletion pkg/controller/controller_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

err := (&crscheme.Builder{
GroupVersion: schema.GroupVersion{Group: "chaosapps.metamagical.io", Version: "v1"},
Expand Down
2 changes: 1 addition & 1 deletion pkg/envtest/envtest_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestSource(t *testing.T) {
var env *Environment

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
env = &Environment{}
// we're initializing webhook here and not in webhook.go to also test the envtest install code via WebhookOptions
initializeWebhookInEnvironment()
Expand Down
2 changes: 1 addition & 1 deletion pkg/handler/eventhandler_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var testenv *envtest.Environment
var cfg *rest.Config

var _ = BeforeSuite(func() {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}
var err error
Expand Down
2 changes: 1 addition & 1 deletion pkg/healthz/healthz_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ func TestHealthz(t *testing.T) {
}

var _ = BeforeSuite(func() {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
})
2 changes: 1 addition & 1 deletion pkg/internal/controller/controller_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
3 changes: 0 additions & 3 deletions pkg/internal/log/log.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

// Package log contains utilities for fetching a new logger
// when one is not already available.
// Deprecated: use pkg/log
package log

import (
Expand Down
2 changes: 1 addition & 1 deletion pkg/internal/recorder/recorder_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
33 changes: 0 additions & 33 deletions pkg/log/zap/zap.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,39 +37,6 @@ func New(opts ...Opts) logr.Logger {
return zapr.NewLogger(NewRaw(opts...))
}

// Logger is a Logger implementation.
// If development is true, a Zap development config will be used
// (stacktraces on warnings, no sampling), otherwise a Zap production
// config will be used (stacktraces on errors, sampling).
//
// Deprecated: use New() and the functional opts pattern instead:
//
// New(UseDevMode(development))
func Logger(development bool) logr.Logger {
return LoggerTo(os.Stderr, development)
}

// LoggerTo returns a new Logger implementation using Zap which logs
// to the given destination, instead of stderr. It otherwise behaves like
// ZapLogger.
//
// Deprecated: use New() and the functional opts pattern instead:
//
// New(UseDevMode(development), WriteTo(writer))
func LoggerTo(destWriter io.Writer, development bool) logr.Logger {
return zapr.NewLogger(RawLoggerTo(destWriter, development))
}

// RawLoggerTo returns a new zap.Logger configured with KubeAwareEncoder
// which logs to a given destination
//
// Deprecated: use NewRaw() and the functional opts pattern instead:
//
// NewRaw(UseDevMode(development), WriteTo(destWriter), RawZapOpts(opts...))
func RawLoggerTo(destWriter io.Writer, development bool, opts ...zap.Option) *zap.Logger {
return NewRaw(UseDevMode(development), WriteTo(destWriter), RawZapOpts(opts...))
}

// Opts allows to manipulate Options
type Opts func(*Options)

Expand Down
34 changes: 0 additions & 34 deletions pkg/log/zap/zap_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"bytes"
"encoding/json"
"flag"
"io/ioutil"
"os"

"github.com/go-logr/logr"
Expand Down Expand Up @@ -143,30 +142,6 @@ var _ = Describe("Zap options setup", func() {
})

var _ = Describe("Zap logger setup", func() {
Context("with the default output", func() {
It("shouldn't fail when setting up production", func() {
Expect(Logger(false)).NotTo(BeNil())
Expect(New(UseDevMode(false))).NotTo(BeNil())
})

It("shouldn't fail when setting up development", func() {
Expect(Logger(true)).NotTo(BeNil())
Expect(New(UseDevMode(true))).NotTo(BeNil())
})
})

Context("with custom non-sync output", func() {
It("shouldn't fail when setting up production", func() {
Expect(LoggerTo(ioutil.Discard, false)).NotTo(BeNil())
Expect(New(WriteTo(ioutil.Discard), UseDevMode(false))).NotTo(BeNil())
})

It("shouldn't fail when setting up development", func() {
Expect(LoggerTo(ioutil.Discard, true)).NotTo(BeNil())
Expect(New(WriteTo(ioutil.Discard), UseDevMode(true))).NotTo(BeNil())
})
})

Context("when logging kubernetes objects", func() {
var logOut *bytes.Buffer
var logger logr.Logger
Expand Down Expand Up @@ -288,15 +263,6 @@ var _ = Describe("Zap logger setup", func() {
defineTests()

})
Context("with logger created using LoggerTo", func() {
BeforeEach(func() {
logOut = new(bytes.Buffer)
By("setting up the logger")
// use production settings (false) to get just json output
logger = LoggerTo(logOut, false)
})
defineTests()
})
})
})

Expand Down
2 changes: 1 addition & 1 deletion pkg/manager/manager_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
2 changes: 1 addition & 1 deletion pkg/predicate/predicate_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ func TestPredicate(t *testing.T) {
}

var _ = BeforeSuite(func() {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
})
2 changes: 1 addition & 1 deletion pkg/reconcile/reconcile_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ func TestReconcile(t *testing.T) {
}

var _ = BeforeSuite(func() {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
})
58 changes: 0 additions & 58 deletions pkg/runtime/log/log.go

This file was deleted.

2 changes: 1 addition & 1 deletion pkg/source/internal/internal_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ func TestInternal(t *testing.T) {
}

var _ = BeforeSuite(func() {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
})
2 changes: 1 addition & 1 deletion pkg/source/source_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ var stop chan struct{}

var _ = BeforeSuite(func(done Done) {
stop = make(chan struct{})
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down
2 changes: 1 addition & 1 deletion pkg/webhook/admission/admission_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestAdmissionWebhook(t *testing.T) {
}

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

close(done)
}, 60)
2 changes: 1 addition & 1 deletion pkg/webhook/conversion/conversion_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func TestConversionWebhook(t *testing.T) {
}

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

close(done)
})
2 changes: 1 addition & 1 deletion pkg/webhook/webhook_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var cfg *rest.Config
var clientset *kubernetes.Clientset

var _ = BeforeSuite(func(done Done) {
logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

testenv = &envtest.Environment{}

Expand Down