Demo commit

README.md

@@ -89,3 +89,5 @@ To setup and develop locally or contribute to the open source project, follow ou
 <a href="https://github.com/triggerdotdev/trigger.dev/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=triggerdotdev/trigger.dev" />
 </a>
+
+## Test

chapter_api_tests/2024-04/validation/test_delete_api-v1-projects-{projectRef}-envvars-{env}-{name}.ts

@@ -0,0 +1,163 @@
+import axios, { AxiosInstance, AxiosResponse } from 'axios';
+import { describe, beforeAll, test, expect } from '@jest/globals';
+
+// Example interfaces based on the provided OpenAPI schema references.
+// Adjust or enrich these according to your actual schemas.
+interface SucceedResponse {
+  success: boolean;
+  message: string;
+}
+
+interface ErrorResponse {
+  error: string;
+  message: string;
+}
+
+// Utility function for checking if a string is empty or has only whitespace.
+// Used to test edge cases with path parameters.
+function isEmptyOrWhitespace(str: string): boolean {
+  return !str || !str.trim();
+}
+
+// Test suite for DELETE /api/v1/projects/{projectRef}/envvars/{env}/{name}
+describe('DELETE /api/v1/projects/{projectRef}/envvars/{env}/{name}', () => {
+  let axiosInstance: AxiosInstance;
+
+  // Set up axios instance before tests.
+  beforeAll(() => {
+    axiosInstance = axios.create({
+      baseURL: process.env.API_BASE_URL,
+      // Let the test handle status codes, so we set validateStatus to always return true.
+      validateStatus: () => true,
+    });
+  });
+
+  test('Should delete environment variable successfully (200)', async () => {
+    // Arrange
+    const projectRef = 'my-project';
+    const env = 'development';
+    const name = 'TEST_VAR';
+
+    // Act
+    const response: AxiosResponse<SucceedResponse | ErrorResponse> = await axiosInstance.delete(
+      `/api/v1/projects/${projectRef}/envvars/${env}/${name}`,
+      {
+        headers: {
+          'Authorization': `Bearer ${process.env.API_AUTH_TOKEN}`,
+        },
+      }
+    );
+
+    // Assert: 200 Success
+    // The API specification indicates a 200 response, but if the server returns 200 or 204, adapt the check.
+    expect([200]).toContain(response.status);
+    expect(response.headers['content-type']).toContain('application/json');
+
+    if (response.status === 200) {
+      // Validate that the response body conforms to SucceedResponse if status is 200.
+      const data = response.data as SucceedResponse;
+      expect(data).toHaveProperty('success');
+      expect(data).toHaveProperty('message');
+    }
+  });
+
+  test('Should return 400 (Or 422) for invalid path parameters', async () => {
+    // Arrange: Use invalid path parameters (e.g., empty or malformed)
+    const invalidProjectRef = '';
+    const invalidEnv = '';
+    const invalidName = '';
+
+    // Act
+    const response: AxiosResponse<ErrorResponse> = await axiosInstance.delete(
+      `/api/v1/projects/${invalidProjectRef}/envvars/${invalidEnv}/${invalidName}`,
+      {
+        headers: {
+          'Authorization': `Bearer ${process.env.API_AUTH_TOKEN}`,
+        },
+      }
+    );
+
+    // Assert: Expect 400 or 422 for invalid input
+    // The API may return 400 or 422 for invalid payload or path parameters.
+    expect([400, 422]).toContain(response.status);
+    expect(response.headers['content-type']).toContain('application/json');
+
+    // Validate error response structure
+    const data = response.data;
+    expect(data).toHaveProperty('error');
+    expect(data).toHaveProperty('message');
+
+    // Further checks on the error content could be done here.
+  });
+
+  test('Should return 401 or 403 if authorization token is missing or invalid', async () => {
+    // Arrange
+    const projectRef = 'my-project';
+    const env = 'development';
+    const name = 'ANOTHER_TEST_VAR';
+
+    // Act
+    // Intentionally omit or use an invalid token.
+    const response: AxiosResponse<ErrorResponse> = await axiosInstance.delete(
+      `/api/v1/projects/${projectRef}/envvars/${env}/${name}`
+      // No headers provided to simulate missing Authorization
+    );
+
+    // Assert: Check 401 or 403. API may return either for unauthorized/forbidden.
+    expect([401, 403]).toContain(response.status);
+    expect(response.headers['content-type']).toContain('application/json');
+
+    // Validate error response.
+    const data = response.data;
+    expect(data).toHaveProperty('error');
+    expect(data).toHaveProperty('message');
+  });
+
+  test('Should return 404 for non-existent environment variable', async () => {
+    // Arrange
+    const projectRef = 'my-project';
+    const env = 'development';
+    const name = 'NON_EXISTENT_VAR';
+
+    // Act
+    const response: AxiosResponse<ErrorResponse> = await axiosInstance.delete(
+      `/api/v1/projects/${projectRef}/envvars/${env}/${name}`,
+      {
+        headers: {
+          'Authorization': `Bearer ${process.env.API_AUTH_TOKEN}`,
+        },
+      }
+    );
+
+    // Assert: Expect 404 if the resource is not found.
+    expect(response.status).toBe(404);
+    expect(response.headers['content-type']).toContain('application/json');
+
+    // Validate error response.
+    const data = response.data;
+    expect(data).toHaveProperty('error');
+    expect(data).toHaveProperty('message');
+  });
+
+  test('Should handle extremely large path parameters gracefully (edge case)', async () => {
+    // Arrange: Create an extremely large string.
+    const largeString = 'x'.repeat(5000); // 5,000 characters
+    const projectRef = largeString;
+    const env = largeString;
+    const name = largeString;
+
+    const response: AxiosResponse<ErrorResponse> = await axiosInstance.delete(
+      `/api/v1/projects/${projectRef}/envvars/${env}/${name}`,
+      {
+        headers: {
+          'Authorization': `Bearer ${process.env.API_AUTH_TOKEN}`,
+        },
+      }
+    );
+
+    // The API might respond with 400, 414 (URI Too Long), or similar.
+    // If it does not handle large inputs, it could return a server error (500+).
+    // Adjust expectations based on actual API behavior.
+    expect([400, 414, 422, 500]).toContain(response.status);
+  });
+});

chapter_api_tests/2024-04/validation/test_delete_api-v1-schedules-{schedule_id}.ts

@@ -0,0 +1,113 @@
+import axios, { AxiosInstance, AxiosResponse } from 'axios';
+import { describe, it, expect, beforeAll, afterAll } from '@jest/globals';
+
+/**
+ * Below tests focus on DELETE /api/v1/schedules/{schedule_id}
+ * using Jest (test framework) + axios (HTTP client) in TypeScript.
+ *
+ * Make sure to:
+ * 1. Set process.env.API_BASE_URL to your API base URL.
+ * 2. Set process.env.API_AUTH_TOKEN to a valid auth token for authorization.
+ * 3. Provide a valid IMPERATIVE schedule ID below if you want to test 200 success.
+ *    (or create one in a setup step if needed.)
+ */
+
+// Example schedule IDs for testing. Modify these to valid/invalid values in your environment.
+// The validScheduleId should reference an existing "IMPERATIVE" schedule.
+const validScheduleId = 'YOUR_VALID_IMPERATIVE_SCHEDULE_ID';
+// A schedule ID that does not exist.
+const nonExistentScheduleId = 'nonexistent-schedule-id';
+// A malformed schedule ID.
+const invalidScheduleId = '!!!';
+
+// Utility function to create an Axios instance.
+function createApiClient(token?: string): AxiosInstance {
+  return axios.create({
+    baseURL: process.env.API_BASE_URL,
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: token ? `Bearer ${token}` : '',
+    },
+    validateStatus: () => true, // allow us to handle status codes ourselves
+  });
+}
+
+// Main test suite
+describe('DELETE /api/v1/schedules/{schedule_id}', () => {
+  let apiClient: AxiosInstance;
+
+  beforeAll(() => {
+    // Create a client with valid auth token
+    apiClient = createApiClient(process.env.API_AUTH_TOKEN);
+  });
+
+  // 1. Input Validation: Missing or invalid parameters
+
+  it('should return 404 (or possibly 400) when schedule_id is empty', async () => {
+    // Attempt to DELETE with an empty schedule ID (effectively /api/v1/schedules/)
+    const response: AxiosResponse = await apiClient.delete('/api/v1/schedules/');
+    // Depending on the server’s configuration, this might return 404, 400, or another error.
+    // We expect an error since the path is incomplete.
+    expect(response.status).toBeGreaterThanOrEqual(400);
+    // Some servers might treat it as 404 Not Found.
+    // If your API returns 400 or 422 for invalid path params, adapt expectations accordingly.
+  });
+
+  it('should return 400 or 422 for a malformed schedule_id', async () => {
+    const response: AxiosResponse = await apiClient.delete(`/api/v1/schedules/${invalidScheduleId}`);
+    // Many APIs will respond with 400 or 422 for invalid ID formats.
+    expect([400, 422]).toContain(response.status);
+  });
+
+  // 2. Response Validation (200 success, 404 Not Found, etc.)
+
+  it('should delete schedule successfully (200) for a valid IMPERATIVE schedule_id', async () => {
+    // If validScheduleId references an existing schedule, we expect a 200.
+    // This test will fail if that schedule does not exist.
+    const response: AxiosResponse = await apiClient.delete(`/api/v1/schedules/${validScheduleId}`);
+    // Check status code
+    expect(response.status).toBe(200);
+    // If the response body has a schema, verify required fields.
+    // e.g., expect(response.data).toHaveProperty('message', 'Schedule deleted successfully');
+
+    // 3. Response Headers Validation
+    expect(response.headers['content-type']).toMatch(/application\/json/i);
+    // If other headers are relevant, check them here.
+  });
+
+  it('should return 404 Not Found for a non-existent schedule_id', async () => {
+    const response: AxiosResponse = await apiClient.delete(`/api/v1/schedules/${nonExistentScheduleId}`);
+    expect(response.status).toBe(404);
+    // Optionally check the response body for error details, if defined.
+    // e.g. expect(response.data).toHaveProperty('error', 'Resource not found');
+  });
+
+  // 4. Edge Case & Limit Testing
+
+  it('should handle extremely large schedule_id gracefully', async () => {
+    const largeScheduleId = 'a'.repeat(1000); // artificially large string
+    const response: AxiosResponse = await apiClient.delete(`/api/v1/schedules/${largeScheduleId}`);
+    // Could be 400, 404, or 414 (URI Too Long) depending on server config.
+    expect(response.status).toBeGreaterThanOrEqual(400);
+  });
+
+  // 5. Testing Authorization & Authentication
+
+  it('should return 401 or 403 when no auth token is provided', async () => {
+    const unauthorizedClient = createApiClient(); // no token
+    const response: AxiosResponse = await unauthorizedClient.delete(`/api/v1/schedules/${validScheduleId}`);
+    expect([401, 403]).toContain(response.status);
+  });
+
+  it('should return 401 or 403 for an invalid auth token', async () => {
+    const invalidAuthClient = createApiClient('invalid-token');
+    const response: AxiosResponse = await invalidAuthClient.delete(`/api/v1/schedules/${validScheduleId}`);
+    expect([401, 403]).toContain(response.status);
+  });
+
+  // Additional tests could be added for server errors (e.g., 500) if you have a way to trigger them.
+
+  afterAll(() => {
+    // Cleanup or restore any resources if needed
+  });
+});

chapter_api_tests/2024-04/validation/test_get_api-v1-projects-{projectRef}-envvars-{env}-{name}.ts

@@ -0,0 +1 @@
+import axios, { AxiosInstance } from 'axios';\nimport { describe, it, beforeAll, afterAll, expect } from '@jest/globals';\n\ndescribe('GET /api/v1/projects/:projectRef/envvars/:env/:name', () => {\n  let client: AxiosInstance;\n  const validProjectRef = 'my-project';\n  const validEnv = 'production';\n  const validName = 'SECRET_KEY';\n  const invalidProjectRef = '';\n  const invalidEnv = '';\n  const invalidName = '';\n\n  beforeAll(() => {\n    const API_BASE_URL = process.env.API_BASE_URL || 'http://localhost:3000';\n    const API_AUTH_TOKEN = process.env.API_AUTH_TOKEN || 'test-token';\n\n    client = axios.create({\n      baseURL: API_BASE_URL,\n      headers: {\n        Authorization: 'Bearer ' + API_AUTH_TOKEN,\n        'Content-Type': 'application/json',\n      },\n      validateStatus: () => true, // We'll handle status checks in tests\n    });\n  });\n\n  afterAll(() => {\n    // any cleanup if needed\n  });\n\n  describe('Valid Request Scenarios', () => {\n    it('should retrieve environment variable when valid parameters are provided', async () => {\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + validName\n      );\n\n      expect(response.status).toBe(200);\n      expect(response.headers['content-type']).toContain('application/json');\n      // Validate response body structure\n      // For demonstration, we do minimal checks; ideally, you check fields from #/components/schemas/EnvVarValue\n      expect(response.data).toHaveProperty('name');\n      expect(response.data.name).toBe(validName);\n    });\n  });\n\n  describe('Input Validation', () => {\n    it('should return 400 or 422 for an invalid projectRef', async () => {\n      const response = await client.get(\n        '/api/v1/projects/' + invalidProjectRef + '/envvars/' + validEnv + '/' + validName\n      );\n\n      expect([400, 422]).toContain(response.status);\n      expect(response.headers['content-type']).toContain('application/json');\n      // check error schema\n      expect(response.data).toHaveProperty('error');\n    });\n\n    it('should return 400 or 422 for an invalid env', async () => {\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + invalidEnv + '/' + validName\n      );\n\n      expect([400, 422]).toContain(response.status);\n      expect(response.headers['content-type']).toContain('application/json');\n      expect(response.data).toHaveProperty('error');\n    });\n\n    it('should return 400 or 422 for an invalid name', async () => {\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + invalidName\n      );\n\n      expect([400, 422]).toContain(response.status);\n      expect(response.headers['content-type']).toContain('application/json');\n      expect(response.data).toHaveProperty('error');\n    });\n  });\n\n  describe('Unauthorized & Forbidden Requests', () => {\n    it('should return 401 or 403 when no authorization token is provided', async () => {\n      const response = await axios.get(\n        (process.env.API_BASE_URL || 'http://localhost:3000') +\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + validName\n      ); // no auth header\n\n      expect([401, 403]).toContain(response.status);\n    });\n\n    it('should return 401 or 403 when an invalid authorization token is provided', async () => {\n      const clientWithInvalidToken = axios.create({\n        baseURL: process.env.API_BASE_URL || 'http://localhost:3000',\n        headers: {\n          Authorization: 'Bearer invalid_token',\n          'Content-Type': 'application/json',\n        },\n        validateStatus: () => true,\n      });\n      const response = await clientWithInvalidToken.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + validName\n      );\n\n      expect([401, 403]).toContain(response.status);\n    });\n  });\n\n  describe('Resource Not Found', () => {\n    it('should return 404 if the environment variable does not exist', async () => {\n      const nonExistentName = 'NON_EXISTENT_VAR';\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + nonExistentName\n      );\n\n      expect(response.status).toBe(404);\n      expect(response.headers['content-type']).toContain('application/json');\n      expect(response.data).toHaveProperty('error');\n    });\n\n    it('should return 404 if the projectRef does not exist', async () => {\n      const fakeProjectRef = 'fakeProject';\n      const response = await client.get(\n        '/api/v1/projects/' + fakeProjectRef + '/envvars/' + validEnv + '/' + validName\n      );\n\n      expect(response.status).toBe(404);\n      expect(response.headers['content-type']).toContain('application/json');\n      expect(response.data).toHaveProperty('error');\n    });\n  });\n\n  describe('Response Headers Validation', () => {\n    it('should include general and security headers in the response', async () => {\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + validName\n      );\n\n      expect(response.status).toBe(200);\n      expect(response.headers['content-type']).toContain('application/json');\n      // if the API includes caching or rate-limiting headers, check them\n      // e.g., expect(response.headers).toHaveProperty('cache-control');\n      // e.g., expect(response.headers).toHaveProperty('x-ratelimit-limit');\n    });\n  });\n\n  describe('Edge Case & Stress Testing', () => {\n    it('should handle extremely long envvar name gracefully (expecting 400/422 or 404)', async () => {\n      const longName = 'A'.repeat(1024);\n      const response = await client.get(\n        '/api/v1/projects/' + validProjectRef + '/envvars/' + validEnv + '/' + longName\n      );\n\n      // Depending on implementation, might be 400, 422, or 404\n      expect([400, 422, 404]).toContain(response.status);\n    });\n  });\n});