Skip to content

Commit 3748b6e

Browse files
getvictorgetvictor
authored
Add gitops integration test for free tier. (#16960)
#13643 - `gitops_integration_test.go` tests free tier and `gitops_enterprise_integration_test.go` tests premium tier - `testing_utils.go` contains the common logic # Checklist for submitter - [x] Added/updated tests
1 parent 25112f2 commit 3748b6e

File tree

3 files changed

+245
-106
lines changed

3 files changed

+245
-106
lines changed

‎cmd/fleetctl/gitops_enterprise_integration_test.go

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
package main
2+
3+
import (
4+
"context"
5+
"fmt"
6+
"github.com/fleetdm/fleet/v4/server/config"
7+
"github.com/fleetdm/fleet/v4/server/datastore/redis/redistest"
8+
"github.com/fleetdm/fleet/v4/server/fleet"
9+
appleMdm "github.com/fleetdm/fleet/v4/server/mdm/apple"
10+
"github.com/fleetdm/fleet/v4/server/ptr"
11+
"github.com/fleetdm/fleet/v4/server/service"
12+
"github.com/fleetdm/fleet/v4/server/test"
13+
"github.com/go-git/go-git/v5"
14+
15+
"github.com/micromdm/nanodep/tokenpki"
16+
"github.com/stretchr/testify/require"
17+
"github.com/stretchr/testify/suite"
18+
"os"
19+
"path"
20+
"path/filepath"
21+
"testing"
22+
)
23+
24+
func TestEnterpriseIntegrationsGitops(t *testing.T) {
25+
testingSuite := new(enterpriseIntegrationGitopsTestSuite)
26+
testingSuite.suite = &testingSuite.Suite
27+
suite.Run(t, testingSuite)
28+
}
29+
30+
type enterpriseIntegrationGitopsTestSuite struct {
31+
suite.Suite
32+
withServer
33+
fleetCfg config.FleetConfig
34+
}
35+
36+
func (s *enterpriseIntegrationGitopsTestSuite) SetupSuite() {
37+
s.withDS.SetupSuite("integrationGitopsTestSuite")
38+
39+
appConf, err := s.ds.AppConfig(context.Background())
40+
require.NoError(s.T(), err)
41+
appConf.MDM.EnabledAndConfigured = true
42+
appConf.MDM.WindowsEnabledAndConfigured = true
43+
appConf.MDM.AppleBMEnabledAndConfigured = true
44+
err = s.ds.SaveAppConfig(context.Background(), appConf)
45+
require.NoError(s.T(), err)
46+
47+
testCert, testKey, err := appleMdm.NewSCEPCACertKey()
48+
require.NoError(s.T(), err)
49+
testCertPEM := tokenpki.PEMCertificate(testCert.Raw)
50+
testKeyPEM := tokenpki.PEMRSAPrivateKey(testKey)
51+
52+
fleetCfg := config.TestConfig()
53+
config.SetTestMDMConfig(s.T(), &fleetCfg, testCertPEM, testKeyPEM, testBMToken, "../../server/service/testdata")
54+
fleetCfg.Osquery.EnrollCooldown = 0
55+
56+
mdmStorage, err := s.ds.NewMDMAppleMDMStorage(testCertPEM, testKeyPEM)
57+
require.NoError(s.T(), err)
58+
depStorage, err := s.ds.NewMDMAppleDEPStorage(*testBMToken)
59+
require.NoError(s.T(), err)
60+
scepStorage, err := s.ds.NewSCEPDepot(testCertPEM, testKeyPEM)
61+
require.NoError(s.T(), err)
62+
redisPool := redistest.SetupRedis(s.T(), "zz", false, false, false)
63+
64+
serverConfig := service.TestServerOpts{
65+
License: &fleet.LicenseInfo{
66+
Tier: fleet.TierPremium,
67+
},
68+
FleetConfig: &fleetCfg,
69+
MDMStorage: mdmStorage,
70+
DEPStorage: depStorage,
71+
SCEPStorage: scepStorage,
72+
Pool: redisPool,
73+
APNSTopic: "com.apple.mgmt.External.10ac3ce5-4668-4e58-b69a-b2b5ce667589",
74+
}
75+
users, server := service.RunServerForTestsWithDS(s.T(), s.ds, &serverConfig)
76+
s.T().Setenv("FLEET_SERVER_ADDRESS", server.URL) // fleetctl always uses this env var in tests
77+
s.server = server
78+
s.users = users
79+
s.fleetCfg = fleetCfg
80+
81+
appConf, err = s.ds.AppConfig(context.Background())
82+
require.NoError(s.T(), err)
83+
appConf.ServerSettings.ServerURL = server.URL
84+
err = s.ds.SaveAppConfig(context.Background(), appConf)
85+
require.NoError(s.T(), err)
86+
}
87+
88+
func (s *enterpriseIntegrationGitopsTestSuite) TearDownSuite() {
89+
appConf, err := s.ds.AppConfig(context.Background())
90+
require.NoError(s.T(), err)
91+
appConf.MDM.EnabledAndConfigured = false
92+
err = s.ds.SaveAppConfig(context.Background(), appConf)
93+
require.NoError(s.T(), err)
94+
}
95+
96+
// TestFleetGitops runs `fleetctl gitops` command on configs in https://github.com/fleetdm/fleet-gitops repo.
97+
// Changes to that repo may cause this test to fail.
98+
func (s *enterpriseIntegrationGitopsTestSuite) TestFleetGitops() {
99+
t := s.T()
100+
const fleetGitopsRepo = "https://github.com/fleetdm/fleet-gitops"
101+
102+
// Create GitOps user
103+
user := fleet.User{
104+
Name: "GitOps User",
105+
Email: "[email protected]",
106+
GlobalRole: ptr.String(fleet.RoleGitOps),
107+
}
108+
require.NoError(t, user.SetPassword(test.GoodPassword, 10, 10))
109+
_, err := s.ds.NewUser(context.Background(), &user)
110+
require.NoError(t, err)
111+
112+
// Create a temporary fleetctl config file
113+
fleetctlConfig, err := os.CreateTemp(t.TempDir(), "*.yml")
114+
require.NoError(t, err)
115+
token := s.getTestToken(user.Email, test.GoodPassword)
116+
configStr := fmt.Sprintf(
117+
`
118+
contexts:
119+
default:
120+
address: %s
121+
tls-skip-verify: true
122+
token: %s
123+
`, s.server.URL, token,
124+
)
125+
_, err = fleetctlConfig.WriteString(configStr)
126+
require.NoError(t, err)
127+
128+
// Clone git repo
129+
repoDir := t.TempDir()
130+
_, err = git.PlainClone(
131+
repoDir, false, &git.CloneOptions{
132+
ReferenceName: "main",
133+
SingleBranch: true,
134+
Depth: 1,
135+
URL: fleetGitopsRepo,
136+
Progress: os.Stdout,
137+
},
138+
)
139+
require.NoError(t, err)
140+
141+
// Set the required environment variables
142+
t.Setenv("FLEET_SSO_METADATA", "sso_metadata")
143+
t.Setenv("FLEET_GLOBAL_ENROLL_SECRET", "global_enroll_secret")
144+
t.Setenv("FLEET_WORKSTATIONS_ENROLL_SECRET", "workstations_enroll_secret")
145+
t.Setenv("FLEET_WORKSTATIONS_CANARY_ENROLL_SECRET", "workstations_canary_enroll_secret")
146+
globalFile := path.Join(repoDir, "default.yml")
147+
teamsDir := path.Join(repoDir, "teams")
148+
teamFiles, err := os.ReadDir(teamsDir)
149+
require.NoError(t, err)
150+
151+
// Dry run
152+
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", globalFile, "--dry-run"})
153+
for _, file := range teamFiles {
154+
if filepath.Ext(file.Name()) == ".yml" {
155+
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", path.Join(teamsDir, file.Name()), "--dry-run"})
156+
}
157+
}
158+
159+
// Real run
160+
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", globalFile})
161+
for _, file := range teamFiles {
162+
if filepath.Ext(file.Name()) == ".yml" {
163+
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", path.Join(teamsDir, file.Name())})
164+
}
165+
}
166+
167+
}

‎cmd/fleetctl/gitops_integration_test.go

+3-106
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
11
package main
22

33
import (
4-
"bytes"
54
"context"
6-
"encoding/json"
75
"fmt"
86
"github.com/fleetdm/fleet/v4/server/config"
9-
"github.com/fleetdm/fleet/v4/server/datastore/mysql"
107
"github.com/fleetdm/fleet/v4/server/datastore/redis/redistest"
118
"github.com/fleetdm/fleet/v4/server/fleet"
129
appleMdm "github.com/fleetdm/fleet/v4/server/mdm/apple"
13-
"github.com/fleetdm/fleet/v4/server/ptr"
1410
"github.com/fleetdm/fleet/v4/server/service"
1511
"github.com/fleetdm/fleet/v4/server/test"
1612
"github.com/go-git/go-git/v5"
1713

18-
nanodepClient "github.com/micromdm/nanodep/client"
1914
"github.com/micromdm/nanodep/tokenpki"
20-
"github.com/stretchr/testify/assert"
2115
"github.com/stretchr/testify/require"
2216
"github.com/stretchr/testify/suite"
23-
"io"
24-
"net/http"
25-
"net/http/httptest"
2617
"os"
2718
"path"
28-
"path/filepath"
2919
"testing"
30-
"time"
3120
)
3221

3322
func TestIntegrationsGitops(t *testing.T) {
@@ -72,7 +61,7 @@ func (s *integrationGitopsTestSuite) SetupSuite() {
7261

7362
serverConfig := service.TestServerOpts{
7463
License: &fleet.LicenseInfo{
75-
Tier: fleet.TierPremium,
64+
Tier: fleet.TierFree,
7665
},
7766
FleetConfig: &fleetCfg,
7867
MDMStorage: mdmStorage,
@@ -108,20 +97,11 @@ func (s *integrationGitopsTestSuite) TestFleetGitops() {
10897
t := s.T()
10998
const fleetGitopsRepo = "https://github.com/fleetdm/fleet-gitops"
11099

111-
// Create GitOps user
112-
user := fleet.User{
113-
Name: "GitOps User",
114-
Email: "[email protected]",
115-
GlobalRole: ptr.String(fleet.RoleGitOps),
116-
}
117-
require.NoError(t, user.SetPassword(test.GoodPassword, 10, 10))
118-
_, err := s.ds.NewUser(context.Background(), &user)
119-
require.NoError(t, err)
120-
121100
// Create a temporary fleetctl config file
122101
fleetctlConfig, err := os.CreateTemp(t.TempDir(), "*.yml")
123102
require.NoError(t, err)
124-
token := s.getTestToken(user.Email, test.GoodPassword)
103+
// GitOps user is a premium feature, so we simply use an admin user.
104+
token := s.getTestToken("[email protected]", test.GoodPassword)
125105
configStr := fmt.Sprintf(
126106
`
127107
contexts:
@@ -150,96 +130,13 @@ contexts:
150130
// Set the required environment variables
151131
t.Setenv("FLEET_SSO_METADATA", "sso_metadata")
152132
t.Setenv("FLEET_GLOBAL_ENROLL_SECRET", "global_enroll_secret")
153-
t.Setenv("FLEET_WORKSTATIONS_ENROLL_SECRET", "workstations_enroll_secret")
154-
t.Setenv("FLEET_WORKSTATIONS_CANARY_ENROLL_SECRET", "workstations_canary_enroll_secret")
155133
globalFile := path.Join(repoDir, "default.yml")
156-
teamsDir := path.Join(repoDir, "teams")
157-
teamFiles, err := os.ReadDir(teamsDir)
158134
require.NoError(t, err)
159135

160136
// Dry run
161137
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", globalFile, "--dry-run"})
162-
for _, file := range teamFiles {
163-
if filepath.Ext(file.Name()) == ".yml" {
164-
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", path.Join(teamsDir, file.Name()), "--dry-run"})
165-
}
166-
}
167138

168139
// Real run
169140
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", globalFile})
170-
for _, file := range teamFiles {
171-
if filepath.Ext(file.Name()) == ".yml" {
172-
_ = runAppForTest(t, []string{"gitops", "--config", fleetctlConfig.Name(), "-f", path.Join(teamsDir, file.Name())})
173-
}
174-
}
175-
176-
}
177-
178-
type withDS struct {
179-
suite *suite.Suite
180-
ds *mysql.Datastore
181-
}
182-
183-
func (ts *withDS) SetupSuite(dbName string) {
184-
t := ts.suite.T()
185-
ts.ds = mysql.CreateNamedMySQLDS(t, dbName)
186-
test.AddAllHostsLabel(t, ts.ds)
187-
188-
// Set up the required fields on AppConfig
189-
appConf, err := ts.ds.AppConfig(context.Background())
190-
require.NoError(t, err)
191-
appConf.OrgInfo.OrgName = "FleetTest"
192-
appConf.ServerSettings.ServerURL = "https://example.org"
193-
err = ts.ds.SaveAppConfig(context.Background(), appConf)
194-
require.NoError(t, err)
195-
}
196-
197-
func (ts *withDS) TearDownSuite() {
198-
_ = ts.ds.Close()
199-
}
200-
201-
type withServer struct {
202-
withDS
203-
204-
server *httptest.Server
205-
users map[string]fleet.User
206-
}
207-
208-
type loginRequest struct {
209-
Email string `json:"email"`
210-
Password string `json:"password"`
211-
}
212-
213-
func (ts *withServer) getTestToken(email string, password string) string {
214-
params := loginRequest{
215-
Email: email,
216-
Password: password,
217-
}
218-
j, err := json.Marshal(&params)
219-
require.NoError(ts.suite.T(), err)
220-
221-
requestBody := io.NopCloser(bytes.NewBuffer(j))
222-
resp, err := http.Post(ts.server.URL+"/api/latest/fleet/login", "application/json", requestBody)
223-
require.NoError(ts.suite.T(), err)
224-
defer func() { _ = resp.Body.Close() }()
225-
assert.Equal(ts.suite.T(), http.StatusOK, resp.StatusCode)
226-
227-
jsn := struct {
228-
User *fleet.User `json:"user"`
229-
Token string `json:"token"`
230-
Err []map[string]string `json:"errors,omitempty"`
231-
}{}
232-
err = json.NewDecoder(resp.Body).Decode(&jsn)
233-
require.NoError(ts.suite.T(), err)
234-
require.Len(ts.suite.T(), jsn.Err, 0)
235-
236-
return jsn.Token
237-
}
238141

239-
var testBMToken = &nanodepClient.OAuth1Tokens{
240-
ConsumerKey: "test_consumer",
241-
ConsumerSecret: "test_secret",
242-
AccessToken: "test_access_token",
243-
AccessSecret: "test_access_secret",
244-
AccessTokenExpiry: time.Date(2999, 1, 1, 0, 0, 0, 0, time.UTC),
245142
}

0 commit comments

Comments
 (0)