Update unit tests

Author: DefCon-007

test/analytics.test.ts

@@ -0,0 +1,147 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import * as apiUtils from '../src/apiUtils'
+
+// Mock dependencies
+vi.mock('../src/apiUtils', () => ({
+  apiRequest: vi.fn().mockResolvedValue({}),
+  DEFAULT_RETRY_OPTIONS: {
+    maxRetries: 3,
+    initialDelayMs: 1000,
+    backoffFactor: 2,
+    nonRetryStatusCodes: [400, 401, 403, 404, 405, 422],
+  },
+}))
+
+// Import the module under test
+import { UserSpecifiedAnalyticsData } from '../src/analytics'
+
+describe('analytics', () => {
+  // Save original environment and console.error
+  const originalEnv = process.env
+  const originalConsoleError = console.error
+
+  // Mock data
+  const mockUserSpecifiedData: UserSpecifiedAnalyticsData = {
+    totalTestScriptsExecuted: 5,
+    isCloudRun: true,
+    isUsingFlags: true,
+    isUsingInspectFlags: false,
+    failFast: true,
+    commentOnPr: true,
+    parallelFlag: false,
+    cloudRunLocally: false,
+    onlyVerifyScripts: false,
+  }
+
+  beforeEach(() => {
+    // Reset mocks and environment before each test
+    vi.resetAllMocks()
+    process.env = { ...originalEnv }
+    console.error = vi.fn()
+
+    // Set up environment variables
+    process.env.GITHUB_ACTION = 'test-action'
+    process.env.GITHUB_WORKFLOW = 'test-workflow'
+  })
+
+  afterEach(() => {
+    // Restore original environment and console.error after each test
+    process.env = originalEnv
+    console.error = originalConsoleError
+    vi.clearAllMocks()
+  })
+
+  describe('sendAnalytics', () => {
+    it('should send analytics data with correct properties', async () => {
+      // We need to use a dynamic import to avoid hoisting issues
+      const { sendAnalytics } = await import('../src/analytics')
+
+      await sendAnalytics(mockUserSpecifiedData)
+
+      // Check that the API request was made with the right data
+      expect(apiUtils.apiRequest).toHaveBeenCalledTimes(1)
+      expect(apiUtils.apiRequest).toHaveBeenCalledWith(
+        expect.any(String),
+        {
+          method: 'POST',
+          body: expect.stringContaining('"source":"github-action"'),
+        },
+        expect.objectContaining({
+          maxRetries: 1,
+        })
+      )
+    })
+
+    it('should use the default analytics URL if not provided in environment', async () => {
+      delete process.env.GRAFANA_ANALYTICS_URL
+
+      // We need to use a dynamic import to avoid hoisting issues
+      const { sendAnalytics } = await import('../src/analytics')
+
+      await sendAnalytics(mockUserSpecifiedData)
+
+      expect(apiUtils.apiRequest).toHaveBeenCalledWith(
+        'https://stats.grafana.org',
+        expect.any(Object),
+        expect.any(Object)
+      )
+    })
+
+    it('should use the custom analytics URL if provided in environment', async () => {
+      process.env.GRAFANA_ANALYTICS_URL = 'https://custom-stats.example.com'
+
+      // We need to use a dynamic import to avoid hoisting issues
+      const { sendAnalytics } = await import('../src/analytics')
+
+      await sendAnalytics(mockUserSpecifiedData)
+
+      expect(apiUtils.apiRequest).toHaveBeenCalledWith(
+        'https://custom-stats.example.com',
+        expect.any(Object),
+        expect.any(Object)
+      )
+    })
+
+    it('should handle errors when sending analytics', async () => {
+      // Mock apiRequest to throw an error
+      vi.mocked(apiUtils.apiRequest).mockRejectedValueOnce(
+        new Error('Network error')
+      )
+
+      // We need to use a dynamic import to avoid hoisting issues
+      const { sendAnalytics } = await import('../src/analytics')
+
+      // Call the function
+      await sendAnalytics(mockUserSpecifiedData)
+
+      // Verify that the error was handled and logged
+      expect(console.error).toHaveBeenCalledWith(
+        'Error sending analytics:',
+        expect.any(Error)
+      )
+    })
+
+    it('should generate a unique usage stats ID when GitHub variables are missing', async () => {
+      // Remove GitHub environment variables
+      delete process.env.GITHUB_ACTION
+      delete process.env.GITHUB_WORKFLOW
+
+      // We need to use a dynamic import to avoid hoisting issues
+      const { sendAnalytics } = await import('../src/analytics')
+
+      await sendAnalytics(mockUserSpecifiedData)
+
+      // Just verify that the API request was made successfully
+      expect(apiUtils.apiRequest).toHaveBeenCalledTimes(1)
+      // The body should contain a usageStatsId even though GitHub variables are missing
+      expect(apiUtils.apiRequest).toHaveBeenCalledWith(
+        expect.any(String),
+        {
+          method: 'POST',
+          body: expect.stringContaining('"usageStatsId"'),
+        },
+        expect.any(Object)
+      )
+    })
+  })
+})

test/index.test.ts

@@ -37,6 +37,10 @@ vi.mock('../src/utils', () => ({
   findTestsToRun: vi.fn(),
 }))
 
+vi.mock('../src/analytics', () => ({
+  sendAnalytics: vi.fn(),
+}))
+
 vi.mock('../src/k6helper', () => ({
   validateTestPaths: vi.fn(),
   executeRunK6Command: vi.fn(),