@sun-asterisk/sunlint 1.3.6 → 1.3.8

package/rules/common/C065_one_behavior_per_test/config.json

@@ -0,0 +1,95 @@
+{
+  "ruleId": "C065",
+  "name": "One Behavior per Test (AAA Pattern)",
+  "description": "Each test case should focus on testing a single behavior to improve clarity and maintainability",
+  "category": "common",
+  "severity": "warn",
+  "languages": ["typescript", "javascript", "java", "csharp", "swift", "kotlin"],
+  "options": {
+    "assertApis": {
+      "javascript": ["expect\\(", "assert\\.", "should\\.", "chai\\.expect"],
+      "typescript": ["expect\\(", "assert\\.", "should\\.", "chai\\.expect"],
+      "java": ["assertThat\\(", "assertEquals\\(", "assertTrue\\(", "assertFalse\\(", "assertNull\\(", "assertNotNull\\("],
+      "csharp": ["Assert\\.", "Xunit\\.Assert", "NUnit\\.Framework\\.Assert"],
+      "swift": ["XCTAssert", "XCTAssertEqual", "XCTAssertTrue", "XCTAssertFalse"],
+      "kotlin": ["assertThat\\(", "assertEquals\\(", "assertTrue\\(", "assertFalse\\("]
+    },
+    "actHeuristics": {
+      "common": ["sut\\.", "\\.create\\(", "\\.update\\(", "\\.delete\\(", "\\.save\\(", "\\.execute\\(", "\\.handle\\(", "\\.run\\(", "\\.call\\(", "\\.process\\(", "service\\.", "repository\\.", "await\\s+\\w+\\."],
+      "javascript": ["\\.mockReturnValue\\(", "\\.mockResolvedValue\\(", "render\\(", "fireEvent\\.(click|submit|keyPress|keyDown|keyUp)", "userService\\.", "api\\.", "fetch\\(", "user\\.click\\(", "user\\.type\\(", "user\\.clear\\("],
+      "typescript": ["\\.mockReturnValue\\(", "\\.mockResolvedValue\\(", "render\\(", "fireEvent\\.(click|submit|keyPress|keyDown|keyUp)", "userService\\.", "api\\.", "fetch\\(", "user\\.click\\(", "user\\.type\\(", "user\\.clear\\("],
+      "java": ["\\.when\\(", "\\.thenReturn\\(", "\\.doReturn\\(", "\\.verify\\("],
+      "csharp": ["\\.Setup\\(", "\\.Returns\\(", "\\.Verify\\("],
+      "swift": ["given\\(", "when\\(", "then\\("],
+      "kotlin": ["every\\s*\\{", "verify\\s*\\{"]
+    },
+    "controlFlow": ["\\bif\\s*\\(", "\\bswitch\\s*\\(", "\\bfor\\s*\\(", "\\bwhile\\s*\\(", "\\btry\\s*\\{"],
+    "testPatterns": {
+      "javascript": ["\\bit\\s*\\(", "\\btest\\s*\\(", "\\bdescribe\\s*\\("],
+      "typescript": ["\\bit\\s*\\(", "\\btest\\s*\\(", "\\bdescribe\\s*\\("],
+      "java": ["@Test", "@ParameterizedTest"],
+      "csharp": ["\\[Test\\]", "\\[Fact\\]", "\\[Theory\\]"],
+      "swift": ["func\\s+test", "XCTestCase"],
+      "kotlin": ["@Test", "fun\\s+test"]
+    },
+    "parameterizedHints": ["test\\.each", "describe\\.each", "@ParameterizedTest", "where\\s*:", "\\[TestCase"],
+    "thresholds": {
+      "maxActsPerTest": 3,
+      "maxUnrelatedExpects": 2,
+      "maxControlFlowStatements": 0,
+      "maxTestMethodsPerFunction": 1
+    },
+    "flags": {
+      "flagControlFlowInTest": true,
+      "treatSnapshotAsSingleAssert": true,
+      "allowMultipleAssertsForSameObject": true,
+      "allowSetupAssertions": true,
+      "allowMultipleUIActions": true
+    },
+    "whitelist": {
+      "setupMethods": ["beforeEach", "setUp", "before", "Given"],
+      "teardownMethods": ["afterEach", "tearDown", "after"],
+      "helperMethods": ["helper", "util", "mock", "stub", "spy"]
+    },
+    "allowlist": {
+      "paths": ["test/", "tests/", "__tests__/", "spec/", "specs/", "*.test.*", "*.spec.*"],
+      "filePatterns": ["\\.test\\.", "\\.spec\\.", "Test\\.java$", "Tests\\.cs$", "Test\\.swift$", "Test\\.kt$"],
+      "formInteractionSequences": [
+        "fireEvent\\.change.*fireEvent\\.blur",
+        "fireEvent\\.change.*fireEvent\\.focus",
+        "user\\.type.*user\\.tab",
+        "user\\.type.*user\\.clear",
+        "render.*fireEvent\\.change.*fireEvent\\.blur"
+      ],
+      "uiInteractionWorkflows": [
+        "fireEvent\\.click.*expect\\(",
+        "fireEvent\\.click.*fireEvent\\.click",
+        "render.*fireEvent\\.click.*expect\\(",
+        "getByRole.*fireEvent\\.click.*expect\\(",
+        "queryByText.*fireEvent\\.click",
+        "user\\.click.*expect\\(",
+        "user\\.click.*user\\.click"
+      ],
+      "setupActionPatterns": [
+        "render\\(",
+        "fireEvent\\.(change|blur|focus|mouseEnter|mouseLeave)",
+        "user\\.(hover|focus|tab|clear)",
+        "\\.mockReturnValue\\(",
+        "\\.mockResolvedValue\\("
+      ],
+      "uiSetupPatterns": [
+        "getByRole\\(",
+        "queryByText\\(",
+        "queryAllByText\\(",
+        "getByText\\(",
+        "findByRole\\(",
+        "act\\(.*render"
+      ]
+    },
+    "overrideExclude": {
+      "enabled": true,
+      "reason": "C065 needs to analyze test files that are typically excluded by project configs",
+      "removePatterns": ["**/*.test.*", "**/*.spec.*", "src/**/*.test.{ts,tsx}", "src/**/*.spec.{ts,tsx}"]
+    }
+  }
+}

package/rules/common/C073_validate_required_config_on_startup/README.md

@@ -0,0 +1,110 @@
+# C073 - Validate Required Configuration on Startup
+
+## Mục tiêu
+Tránh lỗi runtime không rõ nguyên nhân do thiếu hoặc sai cấu hình. Đảm bảo ứng dụng dừng sớm (fail fast) nếu thiếu cấu hình quan trọng.
+
+## Mô tả
+Rule này kiểm tra việc validate cấu hình bắt buộc ngay khi ứng dụng khởi động và yêu cầu hệ thống fail fast nếu có vấn đề với cấu hình.
+
+## Các điều kiện kiểm tra
+
+### 1. Schema Validation hoặc Explicit Checks
+- Tất cả cấu hình bắt buộc phải được validate bằng schema libraries (zod, joi, yup, etc.) hoặc explicit checks
+- Không được truy cập `process.env` mà không có validation
+
+### 2. Fail Fast Behavior
+- Khi phát hiện cấu hình thiếu hoặc không hợp lệ, ứng dụng phải dừng ngay lập tức
+- Sử dụng `process.exit(1)`, `throw Error`, hoặc tương tự
+
+### 3. Centralized Configuration
+- Hạn chế việc truy cập environment variables rải rác trong code
+- Tập trung xử lý cấu hình trong các module chuyên dụng
+
+### 4. No Dangerous Defaults
+- Không sử dụng default values nguy hiểm như empty string, localhost URLs
+- Flag các pattern như `|| ''`, `|| 0`, `|| 'http://localhost'`
+
+### 5. Startup Connectivity Checks
+- Với database hoặc external services, cần có connectivity check khi startup
+- Test kết nối trước khi application bắt đầu phục vụ requests
+
+## Ví dụ
+
+### ❌ Không đúng
+```typescript
+// Không có validation, dangerous defaults
+const config = {
+  apiKey: process.env.API_KEY || 'default-key',
+  dbUrl: process.env.DATABASE_URL || '',
+  port: process.env.PORT || 3000
+};
+
+function startServer() {
+  const server = createServer();
+  server.listen(config.port); // Có thể fail runtime nếu config sai
+}
+```
+
+### ✅ Đúng
+```typescript
+import { z } from 'zod';
+
+const configSchema = z.object({
+  API_KEY: z.string().min(1, 'API_KEY is required'),
+  DATABASE_URL: z.string().url('DATABASE_URL must be valid URL'),
+  PORT: z.string().transform(val => parseInt(val, 10))
+});
+
+function validateConfig() {
+  try {
+    return configSchema.parse(process.env);
+  } catch (error) {
+    console.error('Configuration validation failed:', error.message);
+    process.exit(1); // Fail fast
+  }
+}
+
+export const config = validateConfig();
+
+async function checkDatabaseConnection() {
+  try {
+    const connection = await connectToDatabase(config.DATABASE_URL);
+    await connection.ping();
+  } catch (error) {
+    console.error('Database connection failed:', error.message);
+    process.exit(1); // Fail fast on connectivity issues
+  }
+}
+```
+
+## Cấu hình
+
+### Schema Validation Libraries
+- **TypeScript/JavaScript**: zod, joi, yup, envalid, dotenv-safe, class-validator
+- **Java**: @ConfigurationProperties, @Validated, jakarta.validation, hibernate.validator  
+- **Go**: envconfig, viper
+
+### Fail Fast Mechanisms
+- **TypeScript/JavaScript**: `throw new Error()`, `process.exit(1)`
+- **Java**: `throw new RuntimeException()`, `SpringApplication.exit()`, `System.exit(1)`
+- **Go**: `log.Fatal()`, `panic()`, `os.Exit(1)`
+
+### Policy Options
+- `requireSchemaOrExplicitChecks`: Bắt buộc có validation
+- `requireFailFast`: Bắt buộc có fail fast mechanism
+- `forbidEnvReadsOutsideConfig`: Hạn chế env access ngoài config modules
+- `flagDangerousDefaults`: Cảnh báo về dangerous default values
+- `requireStartupConnectivityChecks`: Yêu cầu connectivity check
+
+## Mức độ nghiêm trọng
+**Error** - Rule này có thể ngăn chặn các lỗi runtime nghiêm trọng và khó debug.
+
+## Ngôn ngữ hỗ trợ
+- TypeScript/JavaScript
+- Java  
+- Go
+
+## Tham khảo
+- [Fail Fast Principle](https://en.wikipedia.org/wiki/Fail-fast)
+- [Configuration Validation Best Practices](https://12factor.net/config)
+- [Schema Validation Libraries](https://github.com/colinhacks/zod)