influxdb/cmd/influxd/launcher/launcher_test.go

302 lines
8.0 KiB
Go

package launcher_test
import (
"context"
"encoding/json"
"fmt"
"io"
"io/fs"
nethttp "net/http"
"os"
"path/filepath"
"strconv"
"testing"
"time"
platform "github.com/influxdata/influxdb/v2"
"github.com/influxdata/influxdb/v2/cmd/influxd/launcher"
_ "github.com/influxdata/influxdb/v2/fluxinit/static"
"github.com/influxdata/influxdb/v2/http"
"github.com/influxdata/influxdb/v2/tenant"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest/observer"
)
// Default context.
var ctx = context.Background()
func TestLauncher_Setup(t *testing.T) {
l := launcher.NewTestLauncher()
l.RunOrFail(t, ctx)
defer l.ShutdownOrFail(t, ctx)
client, err := http.NewHTTPClient(l.URL().String(), "", false)
if err != nil {
t.Fatal(err)
}
svc := &tenant.OnboardClientService{Client: client}
if results, err := svc.OnboardInitialUser(ctx, &platform.OnboardingRequest{
User: "USER",
Password: "PASSWORD",
Org: "ORG",
Bucket: "BUCKET",
}); err != nil {
t.Fatal(err)
} else if results.User.ID == 0 {
t.Fatal("expected user id")
} else if results.Org.ID == 0 {
t.Fatal("expected org id")
} else if results.Bucket.ID == 0 {
t.Fatal("expected bucket id")
} else if results.Auth.Token == "" {
t.Fatal("expected auth token")
}
}
// This is to mimic the UI using cookies as sessions
// rather than authorizations
func TestLauncher_SetupWithUsers(t *testing.T) {
l := launcher.RunAndSetupNewLauncherOrFail(ctx, t)
defer l.ShutdownOrFail(t, ctx)
r, err := nethttp.NewRequest("POST", l.URL().String()+"/api/v2/signin", nil)
if err != nil {
t.Fatal(err)
}
r.SetBasicAuth("USER", "PASSWORD")
resp, err := nethttp.DefaultClient.Do(r)
if err != nil {
t.Fatal(err)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatal(err)
}
if err := resp.Body.Close(); err != nil {
t.Fatal(err)
}
if resp.StatusCode != nethttp.StatusNoContent {
t.Fatalf("unexpected status code: %d, body: %s, headers: %v", resp.StatusCode, body, resp.Header)
}
cookies := resp.Cookies()
if len(cookies) != 1 {
t.Fatalf("expected 1 cookie but received %d", len(cookies))
}
user2 := &platform.User{
Name: "USER2",
}
b, _ := json.Marshal(user2)
r = l.NewHTTPRequestOrFail(t, "POST", "/api/v2/users", l.Auth.Token, string(b))
resp, err = nethttp.DefaultClient.Do(r)
if err != nil {
t.Fatal(err)
}
body, err = io.ReadAll(resp.Body)
if err != nil {
t.Fatal(err)
}
if err := resp.Body.Close(); err != nil {
t.Fatal(err)
}
if resp.StatusCode != nethttp.StatusCreated {
t.Fatalf("unexpected status code: %d, body: %s, headers: %v", resp.StatusCode, body, resp.Header)
}
r, err = nethttp.NewRequest("GET", l.URL().String()+"/api/v2/users", nil)
if err != nil {
t.Fatal(err)
}
r.AddCookie(cookies[0])
resp, err = nethttp.DefaultClient.Do(r)
if err != nil {
t.Fatal(err)
}
body, err = io.ReadAll(resp.Body)
if err != nil {
t.Fatal(err)
}
if err := resp.Body.Close(); err != nil {
t.Fatal(err)
}
if resp.StatusCode != nethttp.StatusOK {
t.Fatalf("unexpected status code: %d, body: %s, headers: %v", resp.StatusCode, body, resp.Header)
}
exp := struct {
Users []platform.User `json:"users"`
}{}
err = json.Unmarshal(body, &exp)
if err != nil {
t.Fatalf("unexpected error unmarshalling user: %v", err)
}
if len(exp.Users) != 2 {
t.Fatalf("unexpected 2 users: %#+v", exp)
}
}
func TestLauncher_PingHeaders(t *testing.T) {
l := launcher.RunAndSetupNewLauncherOrFail(ctx, t)
defer l.ShutdownOrFail(t, ctx)
platform.SetBuildInfo("dev", "none", time.Now().UTC().Format(time.RFC3339))
r, err := nethttp.NewRequest("GET", l.URL().String()+"/ping", nil)
if err != nil {
t.Fatal(err)
}
resp, err := nethttp.DefaultClient.Do(r)
if err != nil {
t.Fatal(err)
}
assert.Equal(t, []string{"OSS"}, resp.Header.Values("X-Influxdb-Build"))
assert.Equal(t, []string{"dev"}, resp.Header.Values("X-Influxdb-Version"))
}
func TestLauncher_PIDFile(t *testing.T) {
pidDir := t.TempDir()
pidFilename := filepath.Join(pidDir, "influxd.pid")
l := launcher.RunAndSetupNewLauncherOrFail(ctx, t, func(o *launcher.InfluxdOpts) {
o.PIDFile = pidFilename
})
defer func() {
l.ShutdownOrFail(t, ctx)
require.NoFileExists(t, pidFilename)
}()
require.FileExists(t, pidFilename)
pidBytes, err := os.ReadFile(pidFilename)
require.NoError(t, err)
require.Equal(t, strconv.Itoa(os.Getpid()), string(pidBytes))
}
func TestLauncher_PIDFile_Locked(t *testing.T) {
pidDir := t.TempDir()
pidFilename := filepath.Join(pidDir, "influxd.pid")
lockContents := []byte("foobar") // something wouldn't appear in normal lock file
// Write PID file to lock out the launcher.
require.NoError(t, os.WriteFile(pidFilename, lockContents, 0666))
require.FileExists(t, pidFilename)
origSt, err := os.Stat(pidFilename)
require.NoError(t, err)
// Make sure we get an error about the PID file from the launcher
l := launcher.NewTestLauncher()
err = l.Run(t, ctx, func(o *launcher.InfluxdOpts) {
o.PIDFile = pidFilename
})
defer func() {
l.ShutdownOrFail(t, ctx)
require.FileExists(t, pidFilename)
contents, err := os.ReadFile(pidFilename)
require.NoError(t, err)
require.Equal(t, lockContents, contents)
curSt, err := os.Stat(pidFilename)
require.NoError(t, err)
// We can't compare origSt and curSt directly because even on mounts
// with "noatime" or "relatime" options, the sys.Atim field can still
// change. We'll just compare the most relevant exposed fields.
require.Equal(t, origSt.ModTime(), curSt.ModTime())
require.Equal(t, origSt.Mode(), curSt.Mode())
}()
require.ErrorIs(t, err, launcher.ErrPIDFileExists)
require.ErrorContains(t, err, fmt.Sprintf("error writing PIDFile %q: PID file exists (possible unclean shutdown or another instance already running)", pidFilename))
}
func TestLauncher_PIDFile_Overwrite(t *testing.T) {
pidDir := t.TempDir()
pidFilename := filepath.Join(pidDir, "influxd.pid")
lockContents := []byte("foobar") // something wouldn't appear in normal lock file
// Write PID file to lock out the launcher (or not in this case).
require.NoError(t, os.WriteFile(pidFilename, lockContents, 0666))
require.FileExists(t, pidFilename)
// Make sure we get an error about the PID file from the launcher.
l := launcher.NewTestLauncher()
loggerCore, ol := observer.New(zap.WarnLevel)
l.Logger = zap.New(loggerCore)
err := l.Run(t, ctx, func(o *launcher.InfluxdOpts) {
o.PIDFile = pidFilename
o.OverwritePIDFile = true
})
defer func() {
l.ShutdownOrFail(t, ctx)
require.NoFileExists(t, pidFilename)
}()
require.NoError(t, err)
expLogs := []observer.LoggedEntry{
{
Entry: zapcore.Entry{Level: zap.WarnLevel, Message: "PID file already exists, attempting to overwrite"},
Context: []zapcore.Field{zap.String("pidFile", pidFilename)},
},
}
require.Equal(t, expLogs, ol.AllUntimed())
require.FileExists(t, pidFilename)
pidBytes, err := os.ReadFile(pidFilename)
require.NoError(t, err)
require.Equal(t, strconv.Itoa(os.Getpid()), string(pidBytes))
}
func TestLauncher_PIDFile_OverwriteFail(t *testing.T) {
if os.Geteuid() == 0 {
t.Skip("test will fail when run as root")
}
pidDir := t.TempDir()
pidFilename := filepath.Join(pidDir, "influxd.pid")
lockContents := []byte("foobar") // something wouldn't appear in normal lock file
// Write PID file to lock out the launcher.
require.NoError(t, os.WriteFile(pidFilename, lockContents, 0666))
require.FileExists(t, pidFilename)
require.NoError(t, os.Chmod(pidFilename, 0000))
// Make sure we get an error about the PID file from the launcher
l := launcher.NewTestLauncher()
err := l.Run(t, ctx, func(o *launcher.InfluxdOpts) {
o.PIDFile = pidFilename
o.OverwritePIDFile = true
})
defer func() {
l.ShutdownOrFail(t, ctx)
require.NoError(t, os.Chmod(pidFilename, 0644))
require.FileExists(t, pidFilename)
pidBytes, err := os.ReadFile(pidFilename)
require.NoError(t, err)
require.Equal(t, lockContents, pidBytes)
}()
require.ErrorContains(t, err, fmt.Sprintf("error writing PIDFile %[1]q: overwrite file: open %[1]s:", pidFilename))
require.ErrorIs(t, err, fs.ErrPermission)
}