Network Media Mock #

Network Media Mock is a powerful Dart package for mocking HTTP requests for media files in Flutter applications. It enables seamless simulation of network media responses by intercepting HTTP requests and serving local asset files instead. This is ideal for testing, prototyping, or demonstrating applications without relying on live servers.

Supported Widgets #

This tool is designed to work seamlessly with the following widgets:

Image.network
CachedNetworkImage
SvgPicture.network

Features #

Mock Media Responses: Serve media files (e.g., images, PDFs, etc.) directly from local assets instead of fetching them from the internet.
Customizable Mappings: Easily map URLs or MIME types to specific assets.
Regex URL Matching: Use regex patterns to define and match URLs for mocking.
Type Recognition: Automatically detect MIME types from file extensions or URL patterns.
Flexible Configuration: Customize options such as response delays, logging, and default mappings.

Getting Started #

Installation #

To use Network Media Mock, follow these steps:

Add the package to your pubspec.yaml file:

dependencies:
  network_media_mock: <latest-version>

Run the following command to install the package:

flutter pub get

Usage #

Using Default Options #

The simplest way to use Network Media Mock is by enabling it with the default options. This automatically maps common media types to the package’s pre-defined assets.

import 'package:network_media_mock/network_media_mock.dart';

void main() {
  setUpAll(() {
    TestWidgetsFlutterBinding.ensureInitialized();

    // Initialize the package before any of test cases
    HttpOverrides.global = MockHttpOverrides(); // Use default options
  },
  );

  testWidgets(
    'Test Image.network with file extension',
            (WidgetTester tester) async {
      await tester.pumpWidget(
        Image.network(
          //In this case,The format of the file being returned will be determined from the extension.
          //(.jpg in this example)
          'https://anydomain.com/files/18813d1a.jpg',
        ),
      );

      // Your test logic goes here
    },
  );
}

Advanced Usage with Custom Options #

For more control, you can provide custom options such as URL-to-type mappings, MIME type-to-asset mappings, logging, and response delays.

import 'package:network_media_mock/network_media_mock.dart';

void main() {
  setUpAll(() {
    TestWidgetsFlutterBinding.ensureInitialized();

    // Initialize the package before any of test cases
    HttpOverrides.global = MockHttpOverrides(
      options: NetworkMediaMockOptions(
        isLogEnabled: true, // Enable logging
        responseDelay: const Duration(seconds: 2), // Add a delay to simulate network latency
        urlToTypeMappers: [
          // Map URLs matching a regex to a specific MIME type
          UrlToTypeMapping(
            RegExp(r'https://example.com/api/files/.*'),
            MockMimeType.imageSvgXml,
          ),
          UrlToTypeMapping(
            RegExp(r'https://via.placeholder.com/600/.*'),
            MockMimeType.imagePng,
          ),
        ],
        typeToAssetMappers: [
          // Map MIME types to custom assets
          MimeTypeToAssetMapping(MockMimeType.imageJpeg, "assets/custom_image.jpg"),
          MimeTypeToAssetMapping(MockMimeType.applicationPdf, "assets/custom_doc.pdf"),
        ],
      ),
    );
  },
  );

  testWidgets(
    'Test Image.network',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        Image.network(
          //In this case,The format of the file being returned will be determined from the extension.
          //(.jpg in this example)
          'https://anydomain.com/files/18813d1a.jpg',
        ),
      );

      // Your test logic goes here
    },
  );

  testWidgets(
    'Test SvgPicture.network',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        SvgPicture.network(
          // This file type will be detected by the UrlToTypeMapping(*) defined in options.
          'https://example.com/api/files/18813d1a',
        ),
      );

      // Your test logic goes here
    },
  );

  testWidgets(
    'Test CachedNetworkImage',
            (WidgetTester tester) async {
      await tester.pumpWidget(
        CachedNetworkImage(
          imageUrl: 'https://via.placeholder.com/600/771796',
        ),
      );

      // Your test logic goes here
    },
  );
}

Declaring Custom Assets #

If you use custom assets, declare them in your app’s pubspec.yaml:

flutter:
  assets:
    - assets/custom_image.jpg
    - assets/custom_doc.pdf

Configuration #