fleet/pkg/fleetdbase/fleetd_base_test.go
Ian Littman 2f25580c3a
Only allow FLEET_DEV_* env vars when --dev is passed, allow overriding configs one at a time in dev (#38652)
Resolves #38484. This includes a CI job change to make sure we don't
introduce any more env vars that don't get proxied (and thus turned off
outside `--dev`).

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.

- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)

## Testing

- [x] Added/updated automated tests

Manual QA touched hot paths, but did _not_ manually test every
FLEET_DEV_* environment variable change.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Centralized dev-mode environment management for consistent FLEET_DEV_*
handling and test-friendly overrides.
* Dev-mode allows targeted overrides for certain dev-only configuration
when running with --dev.

* **Chores**
* Migrated environment access to the centralized dev-mode helper across
the codebase.
  * Added CI checks to enforce proper usage of FLEET_DEV_* variables.

* **Documentation**
  * Added guidance on dev-mode environment variable rules and overrides.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
2026-01-27 14:32:56 -06:00

93 lines
3.3 KiB
Go

package fleetdbase
import (
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"github.com/fleetdm/fleet/v4/server/dev_mode"
"github.com/stretchr/testify/require"
)
func TestGetBaseURL(t *testing.T) {
t.Run("with env variable", func(t *testing.T) {
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", "https://download-testing.fleetdm.com", t)
require.Equal(t, "https://download-testing.fleetdm.com", getBaseURL())
})
t.Run("without env variable", func(t *testing.T) {
require.Equal(t, "https://download.fleetdm.com", getBaseURL())
})
}
func TestGetMetadata(t *testing.T) {
expectedMetadata := &Metadata{
MSIURL: "https://download-testing.fleetdm.com/archive/stable/2024-06-25_03-01-17/fleetd-base.msi",
MSISha256: "456e4f16c437c54d4cfacb54717450f4be582e572b8a7252a0384ac3118fbd11",
PKGURL: "https://download-testing.fleetdm.com/archive/stable/2024-06-25_03-01-17/fleetd-base.pkg",
PKGSha256: "4c914def2af5f4e0f5507e397d1d8af5b5991ea23cf606450787b8377e7bcecd",
ManifestPlistURL: "https://download-testing.fleetdm.com/archive/stable/2024-06-25_03-01-17/fleetd-base-manifest.plist",
Version: "2024-06-25_03-01-17",
}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
require.Equal(t, "/stable/meta.json", r.URL.Path)
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
require.NoError(t, json.NewEncoder(w).Encode(expectedMetadata))
}))
t.Cleanup(server.Close)
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", server.URL, t)
meta, err := GetMetadata()
require.NoError(t, err)
require.Equal(t, expectedMetadata, meta)
}
func TestGetMetadataErrorScenarios(t *testing.T) {
t.Run("invalid URL", func(t *testing.T) {
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", "://invalid-url", t)
_, err := GetMetadata()
require.Error(t, err)
require.Contains(t, err.Error(), "invalid URL")
})
t.Run("non-200 status code", func(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
}))
t.Cleanup(server.Close)
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", server.URL, t)
_, err := GetMetadata()
require.Error(t, err)
require.Contains(t, err.Error(), "unexpected status code")
})
t.Run("JSON decoding failure", func(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, err := w.Write([]byte("{invalid-json}"))
require.NoError(t, err)
}))
t.Cleanup(server.Close)
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", server.URL, t)
_, err := GetMetadata()
require.Error(t, err)
require.Contains(t, err.Error(), "failed to decode response")
})
}
func TestGetPKGManifestURL(t *testing.T) {
t.Run("with env variable", func(t *testing.T) {
dev_mode.SetOverride("FLEET_DEV_DOWNLOAD_FLEETDM_URL", "https://download-test.fleetdm.com", t)
require.Equal(t, "https://download-test.fleetdm.com/stable/fleetd-base-manifest.plist", GetPKGManifestURL())
})
t.Run("without env variable", func(t *testing.T) {
require.Equal(t, "https://download.fleetdm.com/stable/fleetd-base-manifest.plist", GetPKGManifestURL())
})
}