Add unit test for stderr/stdout error log (#1054)

* add unit test to check expected error log output for stderr/stdout

* Update order of tests and labels

Author: NutsaB

internal/watcher/instance/nginx_config_parser_test.go

@@ -293,6 +293,7 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 		name                  string
 		content               string
 		expectedConfigContext *model.NginxConfigContext
+		expectedLog           string
 		allowedDirectories    []string
 	}{
 		{
@@ -312,6 +313,7 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 				protos.GetNginxOssInstance([]string{}).GetInstanceMeta().GetInstanceId(),
 				[]string{"127.0.0.1:1515"},
 			),
+			expectedLog:        "",
 			allowedDirectories: []string{dir},
 		},
 		{
@@ -331,6 +333,7 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 				protos.GetNginxPlusInstance([]string{}).GetInstanceMeta().GetInstanceId(),
 				[]string{"127.0.0.1:1515"},
 			),
+			expectedLog:        "",
 			allowedDirectories: []string{dir},
 		},
 		{
@@ -366,6 +369,7 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 				},
 				NAPSysLogServers: nil,
 			},
+			expectedLog:        "",
 			allowedDirectories: []string{dir},
 		},
 		{
@@ -383,6 +387,46 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 			},
 			allowedDirectories: []string{dir},
 		},
+		{
+			name:     "Test 5: Error Log outputting to stderr",
+			instance: protos.GetNginxPlusInstance([]string{}),
+			content: testconfig.GetNginxConfigWithMultipleAccessLogs(
+				"stderr",
+				accessLog.Name(),
+				combinedAccessLog.Name(),
+				ltsvAccessLog.Name(),
+			),
+			expectedConfigContext: modelHelpers.GetConfigContextWithoutErrorLog(
+				accessLog.Name(),
+				combinedAccessLog.Name(),
+				ltsvAccessLog.Name(),
+				protos.GetNginxPlusInstance([]string{}).GetInstanceMeta().GetInstanceId(),
+				[]string{"127.0.0.1:1515"},
+			),
+			expectedLog: "Currently error log outputs to stderr. Log monitoring is disabled while applying a " +
+				"config; log errors to file to enable error monitoring",
+			allowedDirectories: []string{dir},
+		},
+		{
+			name:     "Test 6: Error Log outputting to stdout",
+			instance: protos.GetNginxPlusInstance([]string{}),
+			content: testconfig.GetNginxConfigWithMultipleAccessLogs(
+				"stdout",
+				accessLog.Name(),
+				combinedAccessLog.Name(),
+				ltsvAccessLog.Name(),
+			),
+			expectedConfigContext: modelHelpers.GetConfigContextWithoutErrorLog(
+				accessLog.Name(),
+				combinedAccessLog.Name(),
+				ltsvAccessLog.Name(),
+				protos.GetNginxPlusInstance([]string{}).GetInstanceMeta().GetInstanceId(),
+				[]string{"127.0.0.1:1515"},
+			),
+			expectedLog: "Currently error log outputs to stdout. Log monitoring is disabled while applying a " +
+				"config; log errors to file to enable error monitoring",
+			allowedDirectories: []string{dir},
+		},
 	}
 
 	for _, test := range tests {
@@ -403,9 +447,17 @@ func TestNginxConfigParser_Parse(t *testing.T) {
 			agentConfig.AllowedDirectories = test.allowedDirectories
 
 			nginxConfig := NewNginxConfigParser(agentConfig)
+
+			logBuf := &bytes.Buffer{}
+			stub.StubLoggerWith(logBuf)
+
 			result, parseError := nginxConfig.Parse(ctx, test.instance)
 			require.NoError(t, parseError)
 
+			helpers.ValidateLog(t, test.expectedLog, logBuf)
+
+			logBuf.Reset()
+
 			assert.ElementsMatch(t, test.expectedConfigContext.Files, result.Files)
 			assert.Equal(t, test.expectedConfigContext.NAPSysLogServers, result.NAPSysLogServers)
 			assert.Equal(t, test.expectedConfigContext.PlusAPI, result.PlusAPI)

test/model/config.go

@@ -72,3 +72,47 @@ func GetConfigContextWithNames(
 		NAPSysLogServers: syslogServers,
 	}
 }
+
+func GetConfigContextWithoutErrorLog(
+	accessLogName,
+	combinedAccessLogName,
+	ltsvAccessLogName,
+	instanceID string,
+	syslogServers []string,
+) *model.NginxConfigContext {
+	return &model.NginxConfigContext{
+		StubStatus: &model.APIDetails{
+			URL:      "",
+			Listen:   "",
+			Location: "",
+		},
+		PlusAPI: &model.APIDetails{
+			URL:      "",
+			Listen:   "",
+			Location: "",
+		},
+		AccessLogs: []*model.AccessLog{
+			{
+				Name:        accessLogName,
+				Format:      "$remote_addr - $remote_user [$time_local]",
+				Readable:    true,
+				Permissions: "0600",
+			},
+			{
+				Name: combinedAccessLogName,
+				Format: "$remote_addr - $remote_user [$time_local] " +
+					"\"$request\" $status $body_bytes_sent \"$http_referer\" \"$http_user_agent\"",
+				Readable:    true,
+				Permissions: "0600",
+			},
+			{
+				Name:        ltsvAccessLogName,
+				Format:      "ltsv",
+				Readable:    true,
+				Permissions: "0600",
+			},
+		},
+		InstanceID:       instanceID,
+		NAPSysLogServers: syslogServers,
+	}
+}