Fix typo

.gitignore

@@ -1,11 +1,12 @@
-.vscode
 *.iml
 .idea/
+.vscode/
 dist/**
 main.exe
-coverage.txt
+coverage.*
 build/
 kor
 !kor/
 *.swp
 hack/exceptions
+.envrc

Makefile

@@ -6,6 +6,9 @@ EXCEPTIONS_FILE_PATTERN := *.json
 build:
 	go build -o build/kor main.go
 
+clean:
+	rm -fr build coverage.txt coverage.html
+
 lint:
 	golangci-lint run
 
@@ -15,6 +18,11 @@ lint-fix:
 test:
 	go test -race -coverprofile=coverage.txt -shuffle on ./...
 
+# TODO: EZ: remove once finished
+cover: test
+	go tool cover -func=coverage.txt
+	go tool cover -o coverage.html -html=coverage.txt
+
 sort-exception-files:
 	@echo "Sorting exception files..."
 	@find $(EXCEPTIONS_DIR) -name '$(EXCEPTIONS_FILE_PATTERN)' -exec sh -c ' \
@@ -36,4 +44,4 @@ validate-exception-sorting:
 	done; \
 	if [ "$$PRINT_ERR" = 0 ]; then \
 		echo "Run the following command to sort all files recursively: make sort-exception-files"; \
-	fi; \
+	fi; \

README.md

@@ -30,6 +30,7 @@ Kor is a tool to discover unused Kubernetes resources. Currently, Kor can identi
 - DaemonSets
 - StorageClasses
 - NetworkPolicies
+- Namespaces
 
 ![Kor Screenshot](/images/show_reason_screenshot.png)
 
@@ -118,6 +119,7 @@ Kor provides various subcommands to identify and list unused resources. The avai
 - `daemonset`- Gets unused DaemonSets for the specified namespace or all namespaces.
 - `finalizer` - Gets unused pending deletion resources for the specified namespace or all namespaces.
 - `networkpolicy` - Gets unused NetworkPolicies for the specified namespace or all namespaces.
+- `namespace` - Gets unused Namespaces for the specified namespace or all namespaces.
 - `exporter` - Export Prometheus metrics.
 - `version` - Print kor version information.
 

cmd/kor/all.go

@@ -11,7 +11,7 @@ import (
 
 var allCmd = &cobra.Command{
 	Use:   "all",
-	Short: "Gets unused resources",
+	Short: "Gets unused namespaced resources",
 	Args:  cobra.ExactArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		clientset := kor.GetKubeClient(kubeconfig)

cmd/kor/namespaces.go

@@ -0,0 +1,50 @@
+package kor
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/yonahd/kor/pkg/kor"
+	"github.com/yonahd/kor/pkg/utils"
+)
+
+var namespaceCmd = &cobra.Command{
+	Use:     "namespace",
+	Aliases: []string{"ns", "namespaces"},
+	Short:   "Gets unused namespaces",
+	Args:    cobra.ExactArgs(0),
+	Run: func(cmd *cobra.Command, args []string) {
+		ctx := context.Background()
+		clientset := kor.GetKubeClient(kubeconfig)
+		dynamicClient := kor.GetDynamicClient(kubeconfig)
+
+		if response, err := kor.GetUnusedNamespaces(
+			ctx,
+			filterOptions,
+			clientset,
+			dynamicClient,
+			outputFormat,
+			opts,
+		); err != nil {
+			fmt.Println(err)
+		} else {
+			utils.PrintLogo(outputFormat)
+			fmt.Println(response)
+		}
+	},
+}
+
+func init() {
+	namespaceCmd.PersistentFlags().StringSliceVarP(
+		&filterOptions.IgnoreResourceTypes,
+		"ignore-resource-types",
+		"i",
+		filterOptions.IgnoreResourceTypes,
+		"Child resource type selector to filter out from namespace emptiness evaluation,"+
+			" example: --ignore-resource-types secrets,configmaps."+
+			" Types should be specified in a format printed out in NAME column by 'kubectl api-resources --namespaced=true'.",
+	)
+	rootCmd.AddCommand(namespaceCmd)
+}

go.mod

@@ -7,6 +7,7 @@ toolchain go1.22.2
 require (
 	github.com/fatih/color v1.17.0
 	github.com/olekukonko/tablewriter v0.0.5
+	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.19.1
 	github.com/spf13/cobra v1.8.1
 	k8s.io/api v0.30.2
@@ -43,7 +44,6 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_model v0.5.0 // indirect
 	github.com/prometheus/common v0.48.0 // indirect
 	github.com/prometheus/procfs v0.12.0 // indirect

pkg/filters/filters.go

@@ -15,6 +15,26 @@ const (
 	KorLabelFilterName = "korlabel"
 )
 
+var (
+	SystemNamespaceNames = []string{"default", "kube-system", "kube-public", "kube-node-lease"}
+)
+
+type FilterFunction func(object runtime.Object, opts *Options) bool
+
+// ApplyFilters is a function to apply a list of FilterFunctions to a given object
+func ApplyFilters(
+	object runtime.Object,
+	opts *Options,
+	funcsToCall ...FilterFunction,
+) bool {
+	for _, fn := range funcsToCall {
+		if pass := fn(object, opts); pass {
+			return true
+		}
+	}
+	return false
+}
+
 // KorLabelFilter is a filter that filters out resources that are ["kor/used"] != "true"
 func KorLabelFilter(object runtime.Object, opts *Options) bool {
 	if meta, ok := object.(metav1.Object); ok {
@@ -107,3 +127,49 @@ func HasIncludedAge(creationTime metav1.Time, filterOpts *Options) (bool, error)
 
 	return true, nil
 }
+
+// SystemNamespaceFilter is a filter that filters out namespaces that are created with the cluster by default
+func SystemNamespaceFilter(object runtime.Object, filterOpts *Options) bool {
+	if meta, ok := object.(metav1.Object); ok {
+		namespaceName := meta.GetName()
+		for _, systemNamespace := range SystemNamespaceNames {
+			if namespaceName == systemNamespace {
+				return true
+			}
+		}
+	}
+	return false
+}
+
+// ExcludeNamespacesFilter is a filter that filters out namespaces specified by user
+func ExcludeNamespacesFilter(object runtime.Object, filterOpts *Options) bool {
+	if filterOpts.ExcludeNamespaces != nil {
+		excludeList := filterOpts.ExcludeNamespaces
+		if meta, ok := object.(metav1.Object); ok {
+			namespaceName := meta.GetName()
+			for _, unwantedNamespace := range excludeList {
+				if namespaceName == unwantedNamespace {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
+// IncludeNamespacesFilter is a filter that acts as a whitelist, only these namespaces will be processed if specified
+func IncludeNamespacesFilter(object runtime.Object, filterOpts *Options) bool {
+	if filterOpts.IncludeNamespaces != nil {
+		includeList := filterOpts.IncludeNamespaces
+		if meta, ok := object.(metav1.Object); ok {
+			namespaceName := meta.GetName()
+			for _, wantedNamespace := range includeList {
+				if namespaceName == wantedNamespace {
+					return false
+				}
+			}
+		}
+		return true
+	}
+	return false
+}