New version of operator docs (#638)

.github/workflows/docs.yaml

@@ -6,7 +6,7 @@ on:
       - master
     paths:
       - '.github/workflows/docs.yaml'
-      - 'docs/CHANGELOG.MD'
+      - 'docs/CHANGELOG.md'
       - 'api/v1beta1/*types.go'
       - 'api/v1beta1/additional.go'
       - 'api/victoriametrics/v1beta1/*types.go'
@@ -71,9 +71,9 @@ jobs:
 
       - name: Update CHANGELOG in VM docs
         run: |
-          cat ./docs/CHANGELOG.MD > ../__vm-docs-repo/docs/operator/CHANGELOG.md
-          cat ./vars.MD > ../__vm-docs-repo/docs/operator/vars.md
-          cat ./doc_api.MD > ../__vm-docs-repo/docs/operator/api.md
+          cat ./docs/CHANGELOG.md > ../__vm-docs-repo/docs/operator/CHANGELOG.md
+          cat ./vars.md > ../__vm-docs-repo/docs/operator/vars.md
+          cat ./doc_api.md > ../__vm-docs-repo/docs/operator/api.md
         working-directory: "__vm-operator-repo"
 
       - name: Commit and push changes

Makefile

@@ -198,7 +198,7 @@ fix_crd_nulls_yaml:
 
 
 doc: install-develop-tools
-	cat hack/doc_header.md > doc_api.MD
+	cat hack/doc_header.md > doc_api.md
 	doc-print --paths=\
 	$(APIS_BASE_PATH)/vmalertmanager_types.go,\
 	$(APIS_BASE_PATH)/vmalertmanagerconfig_types.go,\
@@ -216,11 +216,11 @@ doc: install-develop-tools
 	$(APIS_BASE_PATH)/vmstaticscrape_types.go,\
 	$(APIS_BASE_PATH)/vmprobe_types.go \
 	--owner VictoriaMetrics \
-	>> doc_api.MD
+	>> doc_api.md
 
 operator-conf: install-develop-tools
-	cat hack/doc_vars_header.md > vars.MD
-	envconfig-docs --input internal/config/config.go --truncate=false >> vars.MD
+	cat hack/doc_vars_header.md > vars.md
+	envconfig-docs --input internal/config/config.go --truncate=false >> vars.md
 
 
 docker: build manager

controllers/factory/scrapes_test.go

@@ -27,6 +27,37 @@ func TestSelectServiceMonitors(t *testing.T) {
 		p *victoriametricsv1beta1.VMAgent
 		l logr.Logger
 	}
+
+	predefinedObjects := []runtime.Object{
+		&corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "default"}},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "default", Name: "ss1", Labels: map[string]string{"name": "ss1"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "default", Name: "ss2", Labels: map[string]string{"name": "ss2"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+		&corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "other1", Labels: map[string]string{"name": "other1"}}},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "other1", Name: "ss1", Labels: map[string]string{"name": "ss1"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "other1", Name: "ss2", Labels: map[string]string{"name": "ss2"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+		&corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "other2", Labels: map[string]string{"name": "other2"}}},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "other2", Name: "ss1", Labels: map[string]string{"name": "ss1"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+		&victoriametricsv1beta1.VMServiceScrape{
+			ObjectMeta: metav1.ObjectMeta{Namespace: "other2", Name: "ss2", Labels: map[string]string{"name": "ss2"}},
+			Spec:       victoriametricsv1beta1.VMServiceScrapeSpec{},
+		},
+	}
+
 	tests := []struct {
 		name              string
 		args              args
@@ -87,6 +118,166 @@ func TestSelectServiceMonitors(t *testing.T) {
 			want:    []string{"stg/default-monitor"},
 			wantErr: false,
 		},
+		{
+			name: "If NamespaceSelector and Selector both undefined, selectAllByDefault=false and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: nil,
+						ServiceScrapeSelector:          nil,
+						SelectAllByDefault:             false,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector and Selector both undefined, selectAllByDefault=true and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: nil,
+						ServiceScrapeSelector:          nil,
+						SelectAllByDefault:             true,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"default/ss1", "default/ss2", "other1/ss1", "other1/ss2", "other2/ss1", "other2/ss2"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector defined, Selector undefined, selectAllByDefault=false and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"name": "other1"}},
+						ServiceScrapeSelector:          nil,
+						SelectAllByDefault:             false,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"other1/ss1", "other1/ss2"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector defined, Selector undefined, selectAllByDefault=true and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"name": "other1"}},
+						ServiceScrapeSelector:          nil,
+						SelectAllByDefault:             true,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"other1/ss1", "other1/ss2"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector undefined, Selector defined, selectAllByDefault=false and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: nil,
+						ServiceScrapeSelector:          &metav1.LabelSelector{MatchLabels: map[string]string{"name": "ss1"}},
+						SelectAllByDefault:             false,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"default/ss1"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector undefined, Selector defined, selectAllByDefault=true and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: nil,
+						ServiceScrapeSelector:          &metav1.LabelSelector{MatchLabels: map[string]string{"name": "ss1"}},
+						SelectAllByDefault:             true,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"default/ss1"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector and Selector both defined, selectAllByDefault=false and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"name": "other1"}},
+						ServiceScrapeSelector:          &metav1.LabelSelector{MatchLabels: map[string]string{"name": "ss1"}},
+						SelectAllByDefault:             false,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"other1/ss1"},
+			wantErr:           false,
+		},
+		{
+			name: "If NamespaceSelector and Selector both defined, selectAllByDefault=true and empty watchNS",
+			args: args{
+				p: &victoriametricsv1beta1.VMAgent{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "default-agent",
+						Namespace: "default",
+					},
+					Spec: victoriametricsv1beta1.VMAgentSpec{
+						ServiceScrapeNamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"name": "other2"}},
+						ServiceScrapeSelector:          &metav1.LabelSelector{MatchLabels: map[string]string{"name": "ss2"}},
+						SelectAllByDefault:             true,
+					},
+				},
+				l: logf.Log.WithName("unit-test"),
+			},
+			predefinedObjects: predefinedObjects,
+			want:              []string{"other2/ss2"},
+			wantErr:           false,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {