Skip to content

Commit

Permalink
Attempt to fix executor recognition for analytics source and updated …
Browse files Browse the repository at this point in the history 
…integration tests.
  • Loading branch information
@mitchell-as
mitchell-as committed Sep 13, 2023
1 parent 1a6ad98 commit e90f8ea
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 26 deletions.
6 changes: 3 additions & 3 deletions pkg/platform/runtime/analytics/analytics.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ import (
"github.com/ActiveState/cli/internal/analytics"
anaConsts "github.com/ActiveState/cli/internal/analytics/constants"
"github.com/ActiveState/cli/internal/analytics/dimensions"
"github.com/ActiveState/cli/internal/constants"
"github.com/ActiveState/cli/internal/osutils"
"github.com/ActiveState/cli/pkg/platform/runtime/executors"
)

var isExecutor bool

func init() {
if osutils.Executable() == constants.StateExecutorCmd {
isExecutor = true
if isExec, err := executors.IsExecutor(osutils.Executable()); err == nil {
isExecutor = isExec
}
}

Expand Down
42 changes: 21 additions & 21 deletions test/integration/analytics_int_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,16 @@ func (suite *AnalyticsIntegrationTestSuite) TestActivateEvents() {
suite.Require().NotEmpty(events)

// Runtime:start events
suite.assertNEvents(events, 1, anaConst.CatRuntime, anaConst.ActRuntimeStart,
suite.assertNEvents(events, 1, anaConst.CatRuntime, anaConst.ActRuntimeStart, anaConst.SrcStateTool,
fmt.Sprintf("output:\n%s\n%s",
cp.Snapshot(), ts.DebugLogs()))

// Runtime:success events
suite.assertNEvents(events, 1, anaConst.CatRuntime, anaConst.ActRuntimeSuccess,
suite.assertNEvents(events, 1, anaConst.CatRuntime, anaConst.ActRuntimeSuccess, anaConst.SrcStateTool,
fmt.Sprintf("output:\n%s\n%s",
cp.Snapshot(), ts.DebugLogs()))

heartbeatInitialCount := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
heartbeatInitialCount := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor)
if heartbeatInitialCount < 2 {
// It's possible due to the timing of the heartbeats and the fact that they are async that we have gotten either
// one or two by this point. Technically more is possible, just very unlikely.
Expand All @@ -104,7 +104,7 @@ func (suite *AnalyticsIntegrationTestSuite) TestActivateEvents() {
suite.Require().NotEmpty(events)

// Runtime-use:heartbeat events - should now be at least +1 because we waited <heartbeatInterval>
suite.assertGtEvents(events, heartbeatInitialCount, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat,
suite.assertGtEvents(events, heartbeatInitialCount, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor,
fmt.Sprintf("output:\n%s\n%s",
cp.Snapshot(), ts.DebugLogs()))

Expand All @@ -121,11 +121,11 @@ func (suite *AnalyticsIntegrationTestSuite) TestActivateEvents() {
}
return (*e.Dimensions.Trigger) == target.TriggerExecutor.String()
})
suite.Require().Equal(1, countEvents(executorEvents, anaConst.CatRuntimeUsage, anaConst.ActRuntimeAttempt),
suite.Require().Equal(1, countEvents(executorEvents, anaConst.CatRuntimeUsage, anaConst.ActRuntimeAttempt, anaConst.SrcExecutor),
ts.DebugMessage("Should have a runtime attempt, events:\n"+debugEvents(suite.T(), executorEvents)))
// It's possible due to the timing of the heartbeats and the fact that they are async that we have gotten either
// one or two by this point. Technically more is possible, just very unlikely.
numHeartbeats := countEvents(executorEvents, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
numHeartbeats := countEvents(executorEvents, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor)
suite.Require().Greater(numHeartbeats, 0, "Should have a heartbeat")
suite.Require().LessOrEqual(numHeartbeats, 2, "Should not have excessive heartbeats")
var heartbeatEvent *reporters.TestLogEntry
Expand Down Expand Up @@ -153,13 +153,13 @@ func (suite *AnalyticsIntegrationTestSuite) TestActivateEvents() {

events = parseAnalyticsEvents(suite, ts)
suite.Require().NotEmpty(events)
eventsAfterExit := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
eventsAfterExit := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor)

time.Sleep(sleepTime)

eventsAfter := parseAnalyticsEvents(suite, ts)
suite.Require().NotEmpty(eventsAfter)
eventsAfterWait := countEvents(eventsAfter, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
eventsAfterWait := countEvents(eventsAfter, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor)

suite.Equal(eventsAfterExit, eventsAfterWait,
fmt.Sprintf("Heartbeats should stop ticking after exiting subshell.\n"+
Expand All @@ -177,9 +177,9 @@ func (suite *AnalyticsIntegrationTestSuite) TestActivateEvents() {
suite.assertSequentialEvents(events)
}

func countEvents(events []reporters.TestLogEntry, category, action string) int {
func countEvents(events []reporters.TestLogEntry, category, action, source string) int {
filteredEvents := funk.Filter(events, func(e reporters.TestLogEntry) bool {
return e.Category == category && e.Action == action && e.Source != ""
return e.Category == category && e.Action == action && e.Source == source
}).([]reporters.TestLogEntry)
return len(filteredEvents)
}
Expand All @@ -203,15 +203,15 @@ func filterEvents(events []reporters.TestLogEntry, filters ...func(e reporters.T
}

func (suite *AnalyticsIntegrationTestSuite) assertNEvents(events []reporters.TestLogEntry,
expectedN int, category, action string, errMsg string) {
suite.Assert().Equal(expectedN, countEvents(events, category, action),
expectedN int, category, action, source string, errMsg string) {
suite.Assert().Equal(expectedN, countEvents(events, category, action, source),
"Expected %d %s:%s events.\nFile location: %s\nEvents received:\n%s\nError:\n%s",
expectedN, category, action, suite.eventsfile, suite.summarizeEvents(events), errMsg)
}

func (suite *AnalyticsIntegrationTestSuite) assertGtEvents(events []reporters.TestLogEntry,
greaterThanN int, category, action string, errMsg string) {
suite.Assert().Greater(countEvents(events, category, action), greaterThanN,
greaterThanN int, category, action, source string, errMsg string) {
suite.Assert().Greater(countEvents(events, category, action, source), greaterThanN,
fmt.Sprintf("Expected more than %d %s:%s events.\nFile location: %s\nEvents received:\n%s\nError:\n%s",
greaterThanN, category, action, suite.eventsfile, suite.summarizeEvents(events), errMsg))
}
Expand Down Expand Up @@ -254,16 +254,16 @@ func (suite *AnalyticsIntegrationTestSuite) assertSequentialEvents(events []repo
func (suite *AnalyticsIntegrationTestSuite) summarizeEvents(events []reporters.TestLogEntry) string {
summary := []string{}
for _, event := range events {
summary = append(summary, fmt.Sprintf("%s:%s:%s", event.Category, event.Action, event.Label))
summary = append(summary, fmt.Sprintf("%s:%s:%s (%s)", event.Category, event.Action, event.Label, event.Source))
}
return strings.Join(summary, "\n")
}

func (suite *AnalyticsIntegrationTestSuite) summarizeEventSequence(events []reporters.TestLogEntry) string {
summary := []string{}
for _, event := range events {
summary = append(summary, fmt.Sprintf("%s:%s:%s (seq: %s:%s:%d)\n",
event.Category, event.Action, event.Label,
summary = append(summary, fmt.Sprintf("%s:%s:%s (%s seq: %s:%s:%d)\n",
event.Category, event.Action, event.Label, event.Source,
*event.Dimensions.Command, (*event.Dimensions.InstanceID)[0:6], *event.Dimensions.Sequence))
}
return strings.Join(summary, "\n")
Expand Down Expand Up @@ -423,7 +423,7 @@ func (suite *AnalyticsIntegrationTestSuite) TestInputError() {
events := parseAnalyticsEvents(suite, ts)
suite.assertSequentialEvents(events)

suite.assertNEvents(events, 1, anaConst.CatDebug, anaConst.ActCommandInputError,
suite.assertNEvents(events, 1, anaConst.CatDebug, anaConst.ActCommandInputError, anaConst.SrcStateTool,
fmt.Sprintf("output:\n%s\n%s",
cp.Snapshot(), ts.DebugLogs()))

Expand Down Expand Up @@ -466,7 +466,7 @@ func (suite *AnalyticsIntegrationTestSuite) TestAttempts() {
for _, e := range events {
if strings.Contains(e.Category, "runtime") && strings.Contains(e.Action, "attempt") {
foundAttempts++
if strings.Contains(*e.Dimensions.Trigger, "exec") {
if strings.Contains(*e.Dimensions.Trigger, "exec") && strings.Contains(e.Source, anaConst.SrcExecutor) {
foundExecs++
}
}
Expand Down Expand Up @@ -564,8 +564,8 @@ func (suite *AnalyticsIntegrationTestSuite) TestConfigEvents() {
suite.Fail("Should find multiple config events")
}

suite.assertNEvents(events, 1, anaConst.CatConfig, anaConst.ActConfigSet, "Should be at one config set event")
suite.assertNEvents(events, 1, anaConst.CatConfig, anaConst.ActConfigUnset, "Should be at one config unset event")
suite.assertNEvents(events, 1, anaConst.CatConfig, anaConst.ActConfigSet, anaConst.SrcStateTool, "Should be at one config set event")
suite.assertNEvents(events, 1, anaConst.CatConfig, anaConst.ActConfigUnset, anaConst.SrcStateTool, "Should be at one config unset event")
suite.assertSequentialEvents(events)
}

Expand Down
4 changes: 2 additions & 2 deletions test/integration/offinstall_int_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func (suite *OffInstallIntegrationTestSuite) TestInstallAndUninstall() {
heartbeat := suite.filterEvent(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
suite.assertDimensions(heartbeat)

nDelete := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeDelete)
nDelete := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeDelete, anaConst.SrcOfflineInstaller)
if nDelete != 0 {
suite.FailNow(fmt.Sprintf("Expected 0 delete events, got %d, events:\n%#v", nDelete, events))
}
Expand Down Expand Up @@ -147,7 +147,7 @@ func (suite *OffInstallIntegrationTestSuite) TestInstallAndUninstall() {
// Verify that our analytics event was fired
events := parseAnalyticsEvents(suite, ts)
suite.Require().NotEmpty(events)
nHeartbeat := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat)
nHeartbeat := countEvents(events, anaConst.CatRuntimeUsage, anaConst.ActRuntimeHeartbeat, anaConst.SrcExecutor)
if nHeartbeat != 1 {
suite.FailNow(fmt.Sprintf("Expected 1 heartbeat event, got %d, events:\n%#v", nHeartbeat, events))
}
Expand Down

0 comments on commit e90f8ea

Please sign in to comment.