Skip to content

Expand Config Apply Integration Tests #1246

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Sep 4, 2025
+548 −26
Merged

Expand Config Apply Integration Tests #1246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
960fb4c
WIP test
aphralG Aug 29, 2025
830d5e2
add integration tests
aphralG Sep 3, 2025
ea35811
add integration tests
aphralG Sep 3, 2025
ae3aea6
merge main
aphralG Sep 3, 2025
0b902b8
clean up
aphralG Sep 3, 2025
57a1a26
check test
aphralG Sep 3, 2025
52b36b4
check test
aphralG Sep 3, 2025
d9f5cdf
check test
aphralG Sep 3, 2025
a5c02aa
fix test
aphralG Sep 3, 2025
5969b9f
fix test
aphralG Sep 3, 2025
8b3d99e
fix test
aphralG Sep 3, 2025
38ca6c3
PR feedback
aphralG Sep 4, 2025
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 Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ integration-test: $(SELECTED_PACKAGE) build-mock-management-plane-grpc
TEST_ENV="Container" CONTAINER_OS_TYPE=$(CONTAINER_OS_TYPE) BUILD_TARGET="install-agent-local" CONTAINER_NGINX_IMAGE_REGISTRY=${CONTAINER_NGINX_IMAGE_REGISTRY} \
PACKAGES_REPO=$(OSS_PACKAGES_REPO) PACKAGE_NAME=$(PACKAGE_NAME) BASE_IMAGE=$(BASE_IMAGE) DOCKERFILE_PATH=$(DOCKERFILE_PATH) IMAGE_PATH=$(IMAGE_PATH) TAG=${IMAGE_TAG} \
OS_VERSION=$(OS_VERSION) OS_RELEASE=$(OS_RELEASE) \
go test -v ./test/integration/installuninstall ./test/integration/managementplane ./test/integration/auxiliarycommandserver ./test/integration/nginxless
go test -v ./test/integration/installuninstall ./test/integration/managementplane ./test/integration/auxiliarycommandserver ./test/integration/nginxless

official-image-integration-test: $(SELECTED_PACKAGE) build-mock-management-plane-grpc
TEST_ENV="Container" CONTAINER_OS_TYPE=$(CONTAINER_OS_TYPE) CONTAINER_NGINX_IMAGE_REGISTRY=${CONTAINER_NGINX_IMAGE_REGISTRY} BUILD_TARGET="install" \
Expand Down
5 changes: 5 additions & 0 deletions test/helpers/test_containers_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ func StartContainer(
ContainerFilePath: "/etc/nginx/nginx.conf",
FileMode: configFilePermissions,
},
{
HostFilePath: "../../config/nginx/mime.types",
ContainerFilePath: "/etc/nginx/mime.types",
FileMode: configFilePermissions,
},
},
}

Expand Down
202 changes: 190 additions & 12 deletions test/integration/managementplane/config_apply_test.go
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think we need to add test numbers in test names e.g. TestConfigApply_Test4_TestInvalidConfig. Names should be enough TestConfigApply_InvalidConfig,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed in office - Test Suites run in alphabetical order so to get the tests to run in specific order need to be numbered.

Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ import (
"sort"
"testing"

mpi "github.com/nginx/agent/v3/api/grpc/mpi/v1"
"github.com/nginx/agent/v3/internal/model"
"github.com/nginx/agent/v3/test/integration/utils"

mpi "github.com/nginx/agent/v3/api/grpc/mpi/v1"
"github.com/stretchr/testify/suite"
)

Expand All @@ -26,9 +27,10 @@ const (

type ConfigApplyTestSuite struct {
suite.Suite
ctx context.Context
teardownTest func(testing.TB)
nginxInstanceID string
ctx context.Context
teardownTest func(testing.TB)
nginxInstanceID string
mockManagementConfigDir string
}

type ConfigApplyChunkingTestSuite struct {
Expand All @@ -44,6 +46,9 @@ func (s *ConfigApplyTestSuite) SetupSuite() {
s.teardownTest = utils.SetupConnectionTest(s.T(), false, false, false,
"../../config/agent/nginx-config-with-grpc-client.conf")
s.nginxInstanceID = utils.VerifyConnection(s.T(), 2, utils.MockManagementPlaneAPIAddress)

s.mockManagementConfigDir = "/mock-management-plane-grpc/config/" + s.nginxInstanceID

responses := utils.ManagementPlaneResponses(s.T(), 1, utils.MockManagementPlaneAPIAddress)
s.Require().Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[0].GetCommandResponse().GetStatus())
s.Require().Equal("Successfully updated all files", responses[0].GetCommandResponse().GetMessage())
Expand All @@ -58,30 +63,67 @@ func (s *ConfigApplyTestSuite) TearDownTest() {
utils.ClearManagementPlaneResponses(s.T(), utils.MockManagementPlaneAPIAddress)
}

// Config Apply with no changes to config
func (s *ConfigApplyTestSuite) TestConfigApply_Test1_TestNoConfigChanges() {
slog.Info("starting config apply no config changes test")
utils.PerformConfigApply(s.T(), s.nginxInstanceID, utils.MockManagementPlaneAPIAddress)
responses := utils.ManagementPlaneResponses(s.T(), 2, utils.MockManagementPlaneAPIAddress)
s.T().Logf("Config apply responses: %v", responses)

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/mime.types": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/mime.types",
Hash: "b5XR19dePAcpB9hFYipp0jEQ0SZsFv8SKzEJuLIfOuk=",
Size: 5349,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "gJ1slpIAUmHAiSo5ZIalKvE40b1hJCgaXasQOMab6kc=",
Size: 1172,
Referenced: true,
},
},
}

if os.Getenv("IMAGE_PATH") == "/nginx-plus/agent" {
manifestFiles["/etc/nginx/nginx.conf"].ManifestFileMeta.Hash = "/SWXYYenb2EcJNg6fiuzlkdj91nBdsMdF1vLm7Wybvc="
manifestFiles["/etc/nginx/nginx.conf"].ManifestFileMeta.Size = 1218
}

utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

s.Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[0].GetCommandResponse().GetStatus())
s.Equal("Successfully updated all files", responses[0].GetCommandResponse().GetMessage())
s.Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[1].GetCommandResponse().GetStatus())
s.Equal("Config apply successful, no files to change", responses[1].GetCommandResponse().GetMessage())
slog.Info("finished config apply no config changes test")
}

// Config apply - Add, Update and Delete Referenced file from Management Plane
func (s *ConfigApplyTestSuite) TestConfigApply_Test2_TestValidConfig() {
slog.Info("starting config apply valid config test")
newConfigFile := "../../config/nginx/nginx-with-test-location.conf"
// Update nginx.conf
utils.WriteConfigFileMock(s.T(), s.nginxInstanceID, "/etc/nginx/test/test.conf",
"/etc/nginx/test/test.conf", "/etc/nginx/test/test.conf")

// Delete mime.types
code, _, removeErr := utils.MockManagementPlaneGrpcContainer.Exec(context.Background(), []string{
"rm",
s.mockManagementConfigDir + "/etc/nginx/mime.types",
})

if os.Getenv("IMAGE_PATH") == "/nginx-plus/agent" {
newConfigFile = "../../config/nginx/nginx-plus-with-test-location.conf"
}
s.Require().NoError(removeErr)
s.Equal(0, code)

// Add test.conf
err := utils.MockManagementPlaneGrpcContainer.CopyFileToContainer(
s.ctx,
newConfigFile,
fmt.Sprintf("/mock-management-plane-grpc/config/%s/etc/nginx/nginx.conf", s.nginxInstanceID),
"configs/test.conf",
s.mockManagementConfigDir+"/etc/nginx/test/test.conf",
0o666,
)
s.Require().NoError(err)
Expand All @@ -90,6 +132,27 @@ func (s *ConfigApplyTestSuite) TestConfigApply_Test2_TestValidConfig() {
responses := utils.ManagementPlaneResponses(s.T(), 2, utils.MockManagementPlaneAPIAddress)
s.T().Logf("Config apply responses: %v", responses)

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/test/test.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/test/test.conf",
Hash: "BF1ztX59kP/N81XcIv3JlPp82j7gzTsVIk2RGxdAta8=",
Size: 175,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "/SsQwpZTdJVRa1+bex7OdZoogvVT0tnTOwwO59vpsoM=",
Size: 1360,
Referenced: true,
},
},
}

utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

sort.Slice(responses, func(i, j int) bool {
return responses[i].GetCommandResponse().GetMessage() < responses[j].GetCommandResponse().GetMessage()
})
Expand All @@ -101,7 +164,60 @@ func (s *ConfigApplyTestSuite) TestConfigApply_Test2_TestValidConfig() {
slog.Info("finished config apply valid config test")
}

func (s *ConfigApplyTestSuite) TestConfigApply_Test3_TestInvalidConfig() {
// Add, Update and Delete file on DataPlane - Trigger update file overview
func (s *ConfigApplyTestSuite) TestConfigApply_Test3_DataPlaneUpdate() {
slog.Info("starting config apply data plane update test")
// Add test2.conf to dataplane
err := utils.Container.CopyFileToContainer(
s.ctx,
"configs/test2.conf",
"/etc/nginx/test/test2.conf",
0o666,
)
s.Require().NoError(err)

// Delete test.conf from dataplane
code, _, removeErr := utils.Container.Exec(context.Background(), []string{
"rm",
"/etc/nginx/test/test.conf",
})

s.Require().NoError(removeErr)
s.Equal(0, code)

// Update nginx.conf to reference new file
utils.WriteConfigFileDataplane(s.T(), "/etc/nginx/test/test2.conf",
"/etc/nginx/test/test2.conf", "/etc/nginx/test/test2.conf")

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/test/test2.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/test/test2.conf",
Hash: "mV4nVTx8BObqxSwcJprkJesiCJH+oTO89RgZxFuFEJo=",
Size: 136,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "q8Zf3Cv5UOAVyfigx5Mr4mwJpLIxApN1H0UzYKKTAiU=",
Size: 1363,
Referenced: true,
},
},
}

responses := utils.ManagementPlaneResponses(s.T(), 1, utils.MockManagementPlaneAPIAddress)

utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

s.Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[0].GetCommandResponse().GetStatus())
s.Equal("Successfully updated all files", responses[0].GetCommandResponse().GetMessage())
slog.Info("finished config apply data plane update test")
}

func (s *ConfigApplyTestSuite) TestConfigApply_Test4_TestInvalidConfig() {
slog.Info("starting config apply invalid config test")
err := utils.MockManagementPlaneGrpcContainer.CopyFileToContainer(
s.ctx,
Expand All @@ -116,6 +232,27 @@ func (s *ConfigApplyTestSuite) TestConfigApply_Test3_TestInvalidConfig() {
responses := utils.ManagementPlaneResponses(s.T(), 2, utils.MockManagementPlaneAPIAddress)
s.T().Logf("Config apply responses: %v", responses)

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/test/test2.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/test/test2.conf",
Hash: "mV4nVTx8BObqxSwcJprkJesiCJH+oTO89RgZxFuFEJo=",
Size: 136,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "q8Zf3Cv5UOAVyfigx5Mr4mwJpLIxApN1H0UzYKKTAiU=",
Size: 1363,
Referenced: true,
},
},
}

utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

s.Equal(mpi.CommandResponse_COMMAND_STATUS_ERROR, responses[0].GetCommandResponse().GetStatus())
s.Equal("Config apply failed, rolling back config", responses[0].GetCommandResponse().GetMessage())
s.Equal(configApplyErrorMessage, responses[0].GetCommandResponse().GetError())
Expand All @@ -125,13 +262,33 @@ func (s *ConfigApplyTestSuite) TestConfigApply_Test3_TestInvalidConfig() {
slog.Info("finished config apply invalid config test")
}

func (s *ConfigApplyTestSuite) TestConfigApply_Test4_TestFileNotInAllowedDirectory() {
func (s *ConfigApplyTestSuite) TestConfigApply_Test5_TestFileNotInAllowedDirectory() {
slog.Info("starting config apply file not in allowed directory test")
utils.PerformInvalidConfigApply(s.T(), s.nginxInstanceID)

responses := utils.ManagementPlaneResponses(s.T(), 1, utils.MockManagementPlaneAPIAddress)
s.T().Logf("Config apply responses: %v", responses)

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/test/test2.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/test/test2.conf",
Hash: "mV4nVTx8BObqxSwcJprkJesiCJH+oTO89RgZxFuFEJo=",
Size: 136,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "q8Zf3Cv5UOAVyfigx5Mr4mwJpLIxApN1H0UzYKKTAiU=",
Size: 1363,
Referenced: true,
},
},
}
utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

s.Equal(mpi.CommandResponse_COMMAND_STATUS_FAILURE, responses[0].GetCommandResponse().GetStatus())
s.Equal("Config apply failed", responses[0].GetCommandResponse().GetMessage())
s.Equal(
Expand Down Expand Up @@ -179,6 +336,27 @@ func (s *ConfigApplyChunkingTestSuite) TestConfigApplyChunking() {
return responses[i].GetCommandResponse().GetMessage() < responses[j].GetCommandResponse().GetMessage()
})

manifestFiles := map[string]*model.ManifestFile{
"/etc/nginx/mime.types": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/mime.types",
Hash: "b5XR19dePAcpB9hFYipp0jEQ0SZsFv8SKzEJuLIfOuk=",
Size: 5349,
Referenced: true,
},
},
"/etc/nginx/nginx.conf": {
ManifestFileMeta: &model.ManifestFileMeta{
Name: "/etc/nginx/nginx.conf",
Hash: "dfDpjGOjOhWWhX43y/d+zBulXCisx+BVYj2eEEud6ac=",
Size: 886910,
Referenced: true,
},
},
}

utils.CheckManifestFile(s.T(), utils.Container, manifestFiles)

s.Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[0].GetCommandResponse().GetStatus())
s.Equal("Config apply successful", responses[0].GetCommandResponse().GetMessage())
s.Equal(mpi.CommandResponse_COMMAND_STATUS_OK, responses[1].GetCommandResponse().GetStatus())
Expand Down
25 changes: 25 additions & 0 deletions test/integration/managementplane/configs/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (c) F5, Inc.
//
// This source code is licensed under the Apache License, Version 2.0 license found in the
// LICENSE file in the root directory of this source tree.

package configs

import (
_ "embed"
"fmt"
)

//go:embed nginx.conf
var embedNginxConfWithMultipleInclude string

//go:embed nginx.conf
var embedNginxPlusConfWithMultipleInclude string

func NginxConfigWithMultipleInclude(includeFile1, includeFile2, includeFile3 string) string {
return fmt.Sprintf(embedNginxConfWithMultipleInclude, includeFile1, includeFile2, includeFile3)
}

func NginxPlusConfigWithMultipleInclude(includeFile1, includeFile2, includeFile3 string) string {
return fmt.Sprintf(embedNginxPlusConfWithMultipleInclude, includeFile1, includeFile2, includeFile3)
}
Loading