flutter_test

Instructions

Implementation Reference

• src/tools/flutter.ts:732-785 (handler)

  Executes the flutter_test tool: validates input, checks Flutter project and test file, runs 'flutter test' command with optional coverage, returns results with pass/fail status.

    handler: async (args: any) => {
      const validation = FlutterTestSchema.safeParse(args);
      if (!validation.success) {
        throw new Error(`Invalid request: ${validation.error.message}`);
      }
  
      const { cwd, testFile, coverage = false } = validation.data;
  
      // Validate that it's a Flutter project
      await validateFlutterProject(cwd);
  
      const flutter_args = ['test'];
      
      if (testFile) {
        // Validate test file path (must be .dart file in test directory)
        if (!testFile.endsWith('.dart')) {
          throw new Error(`Test file must be a .dart file. Invalid test file: ${testFile}`);
        }
        
        // Check if test file exists
        const testFilePath = path.isAbsolute(testFile) ? testFile : path.join(cwd, testFile);
        try {
          await fs.access(testFilePath);
        } catch {
          throw new Error(`Test file not found. File does not exist: ${testFilePath}`);
        }
        
        flutter_args.push(testFile);
      }
      
      if (coverage) {
        flutter_args.push('--coverage');
      }
  
      const result = await processExecutor.execute('flutter', flutter_args, {
        cwd,
        timeout: 600000, // 10 minutes timeout for tests
      });
  
      return {
        success: true,
        data: {
          testFile: testFile || 'all tests',
          coverage,
          projectPath: cwd,
          exitCode: result.exitCode,
          output: result.stdout,
          errors: result.stderr,
          duration: result.duration,
          passed: result.exitCode === 0,
        },
      };
    }
  });

• src/tools/flutter.ts:97-101 (schema)

  Zod validation schema for flutter_test tool inputs: project directory (cwd), optional test file, and coverage flag.

  const FlutterTestSchema = z.object({
    cwd: z.string().min(1),
    testFile: z.string().optional(),
    coverage: z.boolean().default(false),
  });

• src/tools/flutter.ts:720-786 (registration)

  Registers the flutter_test tool in the tools map within createFlutterTools function, defining name, description, JSON inputSchema, and handler.

  tools.set('flutter_test', {
    name: 'flutter_test',
    description: 'Run Flutter tests with optional coverage',
    inputSchema: {
      type: 'object',
      properties: {
        cwd: { type: 'string', minLength: 1, description: 'Working directory (Flutter project root)' },
        testFile: { type: 'string', description: 'Specific test file to run (optional)' },
        coverage: { type: 'boolean', description: 'Enable test coverage' }
      },
      required: ['cwd']
    },
    handler: async (args: any) => {
      const validation = FlutterTestSchema.safeParse(args);
      if (!validation.success) {
        throw new Error(`Invalid request: ${validation.error.message}`);
      }
  
      const { cwd, testFile, coverage = false } = validation.data;
  
      // Validate that it's a Flutter project
      await validateFlutterProject(cwd);
  
      const flutter_args = ['test'];
      
      if (testFile) {
        // Validate test file path (must be .dart file in test directory)
        if (!testFile.endsWith('.dart')) {
          throw new Error(`Test file must be a .dart file. Invalid test file: ${testFile}`);
        }
        
        // Check if test file exists
        const testFilePath = path.isAbsolute(testFile) ? testFile : path.join(cwd, testFile);
        try {
          await fs.access(testFilePath);
        } catch {
          throw new Error(`Test file not found. File does not exist: ${testFilePath}`);
        }
        
        flutter_args.push(testFile);
      }
      
      if (coverage) {
        flutter_args.push('--coverage');
      }
  
      const result = await processExecutor.execute('flutter', flutter_args, {
        cwd,
        timeout: 600000, // 10 minutes timeout for tests
      });
  
      return {
        success: true,
        data: {
          testFile: testFile || 'all tests',
          coverage,
          projectPath: cwd,
          exitCode: result.exitCode,
          output: result.stdout,
          errors: result.stderr,
          duration: result.duration,
          passed: result.exitCode === 0,
        },
      };
    }
  });

• src/types/index.ts:140-144 (schema)

  TypeScript type definition and Zod schema export for FlutterTest inputs (slightly variant).

  export const FlutterTestSchema = z.object({
    cwd: z.string(),
    testFile: z.string().optional(),
    coverage: z.boolean().optional(),
  });

• src/tools/flutter.ts:158-169 (helper)

  Helper function to validate that the given directory is a valid Flutter project by checking pubspec.yaml presence and flutter section.

  const validateFlutterProject = async (cwd: string): Promise<void> => {
    const pubspecPath = path.join(cwd, 'pubspec.yaml');
    try {
      await fs.access(pubspecPath);
      const pubspecContent = await fs.readFile(pubspecPath, 'utf8');
      if (!pubspecContent.includes('flutter:')) {
        throw new Error(`Directory does not appear to be a Flutter project. No flutter section found in ${pubspecPath}`);
      }
    } catch {
      throw new Error(`pubspec.yaml not found. Flutter project must contain pubspec.yaml at: ${pubspecPath}`);
    }
  };