Merge pull request #30 from Iterable/MOB-11403-add-tests-for-withstoreconfigvalues

[MOB-11403] add-tests-for-withstoreconfigvalues

Author: lposen

plugin/__mocks__/testUtils.ts

@@ -0,0 +1,117 @@
+import { ExpoConfig } from 'expo/config';
+import {
+  ExportedConfigWithProps,
+  Mod,
+  ModPlatform,
+  ModProps,
+} from 'expo/config-plugins';
+
+// Extend ExpoConfig to include mods
+export interface ConfigWithMods extends ExpoConfig {
+  mods?: {
+    [key in ModPlatform]?: {
+      [key in string]?: Mod<any>;
+    };
+  };
+}
+
+// Type for the result of withIterable
+export type WithIterableResult = ConfigWithMods & {
+  mods: {
+    ios: {
+      infoPlist: Mod<Record<string, any>>;
+      entitlements: Mod<Record<string, any>>;
+      podfile: Mod<Record<string, any>>;
+      dangerous: Mod<Record<string, any>>;
+      xcodeproj: Mod<any>;
+    };
+    android: {
+      manifest: Mod<Record<string, any>>;
+      projectBuildGradle: Mod<Record<string, any>>;
+      appBuildGradle: Mod<Record<string, any>>;
+      dangerous: Mod<Record<string, any>>;
+    };
+  };
+};
+
+/**
+ * Creates a function that generates mock config objects for a given platform.
+ * @param platform - The platform to create the mock config for.
+ * @returns A function that generates mock config objects for the given platform.
+ */
+const createConfigFunction =
+  (platform: ModPlatform) =>
+  (modName: string): ExportedConfigWithProps<Record<string, any>> => ({
+    modResults: {},
+    modRequest: {
+      projectRoot: process.cwd(),
+      platformProjectRoot: process.cwd(),
+      modName,
+      platform,
+      introspect: true,
+      severity: 'info',
+    } as ModProps<Record<string, any>>,
+    modRawConfig: { name: 'TestApp', slug: 'test-app' },
+    name: 'TestApp',
+    slug: 'test-app',
+  });
+
+/**
+ * Creates a mock config object for the iOS platform.
+ * @param modName - The name of the module to create the mock config for.
+ * @returns A mock config object for the iOS platform.
+ */
+export const createMockIosConfig = createConfigFunction('ios');
+
+/**
+ * Creates a mock config object for the Android platform.
+ * @param modName - The name of the module to create the mock config for.
+ * @returns A mock config object for the Android platform.
+ */
+export const createMockConfig = (
+  modName: string
+): ExportedConfigWithProps<Record<string, any>> => ({
+  modResults: {},
+  modRequest: {
+    projectRoot: process.cwd(),
+    platformProjectRoot: process.cwd(),
+    modName,
+    platform: 'android',
+    introspect: true,
+    severity: 'info',
+  } as ModProps<Record<string, any>>,
+  modRawConfig: { name: 'TestApp', slug: 'test-app' },
+  name: 'TestApp',
+  slug: 'test-app',
+});
+
+/**
+ * Creates a mock config object for the Info.plist file.
+ * @param modResults - The results of the module to create the mock config for.
+ * @returns A mock config object for the Info.plist file.
+ */
+export const createMockPlistConfig = (
+  modResults: Record<string, any> = {}
+): ExportedConfigWithProps<Record<string, any>> => ({
+  ...createMockIosConfig('infoPlist'),
+  modResults,
+});
+
+export const createMockManifestConfig = (
+  modResults: Record<string, any> = {}
+): ExportedConfigWithProps<Record<string, any>> => ({
+  ...createMockConfig('manifest'),
+  modResults,
+});
+
+/**
+ * Creates a mock Android manifest object.
+ * @returns A mock Android manifest object.
+ */
+export const createMockAndroidManifest = (): Record<string, any> => ({
+  manifest: {
+    application: [
+      { $: { 'android:name': '.MainApplication' }, activity: [{ $: {} }] },
+    ],
+  },
+});

plugin/__tests__/withStoreConfigValues.test.ts

@@ -0,0 +1,60 @@
+import { type Mod } from 'expo/config-plugins';
+
+import {
+  createMockAndroidManifest,
+  createMockManifestConfig,
+  createMockPlistConfig,
+  type ConfigWithMods,
+  type WithIterableResult,
+} from '../__mocks__/testUtils';
+import withIterable from '../src/withIterable';
+import { type ConfigPluginProps } from '../src/withIterable.types';
+
+const createTestConfig = (): ConfigWithMods => ({
+  name: 'TestApp',
+  slug: 'test-app',
+  ios: { infoPlist: {}, entitlements: {} },
+  android: { googleServicesFile: './__mocks__/google-services.json' },
+  _internal: { projectRoot: process.cwd() },
+});
+
+describe('withStoreConfigValues', () => {
+  it('should store `ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS` in Info.plist', async () => {
+    const config = createTestConfig();
+    const props: ConfigPluginProps = {
+      requestPermissionsForPushNotifications: true,
+    };
+    const result = withIterable(config, props) as WithIterableResult;
+    const modifiedInfoPlist = await result.mods.ios.infoPlist(
+      createMockPlistConfig()
+    );
+    expect(
+      modifiedInfoPlist.modResults
+        .ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS
+    ).toBe(true);
+  });
+
+  it('should add `ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS` to Android Manifest', async () => {
+    const config = createTestConfig();
+    const props: ConfigPluginProps = {
+      requestPermissionsForPushNotifications: true,
+    };
+    const result = withIterable(config, props) as WithIterableResult;
+    const manifestMod = result.mods.android.manifest as Mod<any>;
+    const modifiedManifest = await manifestMod(
+      createMockManifestConfig(createMockAndroidManifest())
+    );
+    const manifest = modifiedManifest.modResults.manifest;
+    expect(manifest.application[0]['meta-data']).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          $: {
+            'android:name':
+              'ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS',
+            'android:value': 'true',
+          },
+        }),
+      ])
+    );
+  });
+});