import type CoreApi from '@actions/core';
import type {Context} from '@actions/github/lib/context';
import type {Octokit} from '@octokit/rest';

import type {RepoImageMeta} from '../src/types';

import {rmSync} from 'fs';

import * as common from '../src/common';
import {updateOtaPR} from '../src/ghw_update_ota_pr';
import {
    BASE_IMAGES_TEST_DIR_PATH,
    getAdjustedContent,
    IMAGE_INVALID,
    IMAGE_V12_1,
    IMAGE_V12_1_METAS,
    IMAGE_V13_1,
    IMAGE_V13_1_METAS,
    IMAGE_V14_1,
    IMAGE_V14_1_METAS,
    IMAGE_V14_2,
    IMAGE_V14_2_METAS,
    PREV_IMAGES_TEST_DIR_PATH,
    useImage,
    withExtraMetas,
} from './data.test';

const github = {
    rest: {
        issues: {
            createComment: jest.fn<
                ReturnType<Octokit['rest']['issues']['createComment']>,
                Parameters<Octokit['rest']['issues']['createComment']>,
                unknown
            >(),
        },
        pulls: {
            createReviewComment: jest.fn<
                ReturnType<Octokit['rest']['pulls']['createReviewComment']>,
                Parameters<Octokit['rest']['pulls']['createReviewComment']>,
                unknown
            >(),
        },
    },
};
const core: Partial<typeof CoreApi> = {
    debug: console.debug,
    info: console.log,
    warning: console.warn,
    error: console.error,
    notice: console.log,
    startGroup: jest.fn(),
    endGroup: jest.fn(),
};
const context: Partial<Context> = {
    payload: {
        pull_request: {
            number: 1,
            head: {
                sha: 'abcd',
            },
        },
    },
    issue: {
        owner: 'Koenkk',
        repo: 'zigbee-OTA',
        number: 1,
    },
    repo: {
        owner: 'Koenkk',
        repo: 'zigbee-OTA',
    },
};

describe('Github Workflow: Update OTA PR', () => {
    let baseManifest: RepoImageMeta[];
    let prevManifest: RepoImageMeta[];
    let readManifestSpy: jest.SpyInstance;
    let writeManifestSpy: jest.SpyInstance;
    let addImageToBaseSpy: jest.SpyInstance;
    let addImageToPrevSpy: jest.SpyInstance;

    const getManifest = (fileName: string): RepoImageMeta[] => {
        if (fileName === common.BASE_INDEX_MANIFEST_FILENAME) {
            return baseManifest;
        } else if (fileName === common.PREV_INDEX_MANIFEST_FILENAME) {
            return prevManifest;
        } else {
            throw new Error(`${fileName} not supported`);
        }
    };

    const setManifest = (fileName: string, content: RepoImageMeta[]): void => {
        const adjustedContent = getAdjustedContent(fileName, content);

        if (fileName === common.BASE_INDEX_MANIFEST_FILENAME) {
            baseManifest = adjustedContent;
        } else if (fileName === common.PREV_INDEX_MANIFEST_FILENAME) {
            prevManifest = adjustedContent;
        } else {
            throw new Error(`${fileName} not supported`);
        }
    };

    const resetManifests = (): void => {
        baseManifest = [];
        prevManifest = [];
    };

    const withBody = (body: string): Partial<Context> => {
        const newContext = structuredClone(context);

        newContext.payload!.pull_request!.body = body;

        return newContext;
    };

    const expectNoChanges = (noReadManifest: boolean = false): void => {
        if (noReadManifest) {
            expect(readManifestSpy).toHaveBeenCalledTimes(0);
        } else {
            expect(readManifestSpy).toHaveBeenCalledTimes(2);
        }

        expect(addImageToBaseSpy).toHaveBeenCalledTimes(0);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(0);
    };

    beforeAll(() => {});

    afterAll(() => {
        readManifestSpy.mockRestore();
        writeManifestSpy.mockRestore();
        addImageToBaseSpy.mockRestore();
        addImageToPrevSpy.mockRestore();
        rmSync(BASE_IMAGES_TEST_DIR_PATH, {recursive: true, force: true});
        rmSync(PREV_IMAGES_TEST_DIR_PATH, {recursive: true, force: true});
    });

    beforeEach(() => {
        resetManifests();

        readManifestSpy = jest.spyOn(common, 'readManifest').mockImplementation(getManifest);
        writeManifestSpy = jest.spyOn(common, 'writeManifest').mockImplementation(setManifest);
        addImageToBaseSpy = jest.spyOn(common, 'addImageToBase');
        addImageToPrevSpy = jest.spyOn(common, 'addImageToPrev');
    });

    afterEach(() => {
        rmSync(BASE_IMAGES_TEST_DIR_PATH, {recursive: true, force: true});
        rmSync(PREV_IMAGES_TEST_DIR_PATH, {recursive: true, force: true});
    });

    // XXX: Util
    // it('Get headers', async () => {
    //     const firmwareBuffer = readFileSync(getImageOriginalDirPath(IMAGE_V14_1));
    //     console.log(IMAGE_V14_1);
    //     console.log(JSON.stringify(common.parseImageHeader(firmwareBuffer)));
    //     console.log(`URL: ${common.getRepoFirmwareFileUrl(IMAGES_TEST_DIR, IMAGE_V14_1, common.BASE_IMAGES_DIR)}`);
    //     console.log(`SHA512: ${common.computeSHA512(firmwareBuffer)}`);
    // })

    it('hard failure from outside PR context', async () => {
        const fileParam: string = `images/test.ota`;

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, {payload: {}}, fileParam);
        }).rejects.toThrow(`Not a pull request`);

        expectNoChanges(true);
    });

    it('hard failure without fileParam', async () => {
        // NOTE: this path should always be prevented by workflow `paths` filter
        const fileParam: string = '';

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(`No file found in pull request.`);

        expectNoChanges(true);
    });

    it('failure with images in images1', async () => {
        const fileParam: string = `images1/test2.ota,images/test.ota`;

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(expect.objectContaining({message: expect.stringContaining(`Detected files in 'images1'`)}));

        expectNoChanges(true);
        expect(github.rest.issues.createComment).toHaveBeenCalledTimes(1);
    });

    it('failure with edited manifest', async () => {
        const fileParam: string = `index.json,images/test.ota`;

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(expect.objectContaining({message: expect.stringContaining(`Detected manual changes in index.json`)}));

        expectNoChanges(true);
        expect(github.rest.issues.createComment).toHaveBeenCalledTimes(1);
    });

    it('failure when no subfolder (manufacturer)', async () => {
        const fileParam: string = `images/test.ota`;

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(
            expect.objectContaining({message: expect.stringContaining(`\`images/test.ota\` should be in its associated manufacturer subfolder.`)}),
        );

        expectNoChanges(false);
        expect(github.rest.pulls.createReviewComment).toHaveBeenCalledTimes(1);
    });

    it('failure with invalid OTA file', async () => {
        const fileParam: string = useImage(IMAGE_INVALID);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(expect.objectContaining({message: expect.stringContaining(`Not a valid OTA file`)}));

        expectNoChanges(false);
        expect(github.rest.pulls.createReviewComment).toHaveBeenCalledTimes(1);
    });

    it('failure with identical OTA file', async () => {
        setManifest(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        const fileParam: string = useImage(IMAGE_V14_1);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(expect.objectContaining({message: expect.stringContaining(`Conflict with image at index \`0\``)}));

        expectNoChanges(false);
        expect(github.rest.pulls.createReviewComment).toHaveBeenCalledTimes(1);
    });

    it('failure with older OTA file that has identical in prev', async () => {
        setManifest(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        setManifest(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
        const fileParam: string = useImage(IMAGE_V13_1);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(
            expect.objectContaining({message: expect.stringContaining(`an equal or better match is already present in prev manifest`)}),
        );

        expectNoChanges(false);
        expect(github.rest.pulls.createReviewComment).toHaveBeenCalledTimes(1);
    });

    it('failure with older OTA file that has newer in prev', async () => {
        setManifest(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        setManifest(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
        const fileParam: string = useImage(IMAGE_V12_1);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, context, fileParam);
        }).rejects.toThrow(
            expect.objectContaining({message: expect.stringContaining(`an equal or better match is already present in prev manifest`)}),
        );

        expectNoChanges(false);
        expect(github.rest.pulls.createReviewComment).toHaveBeenCalledTimes(1);
    });

    it('success into base', async () => {
        const fileParam: string = useImage(IMAGE_V14_1);

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(1);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
    });

    it('success into prev', async () => {
        setManifest(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);

        const fileParam: string = useImage(IMAGE_V13_1);

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(0);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(1);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
    });

    it('success with newer than current without existing prev', async () => {
        const fileParam: string = [useImage(IMAGE_V13_1), useImage(IMAGE_V14_1)].join(',');

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledTimes(2);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(2); // adds both, relocates first during second processing
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
    });

    it('success with newer than current with existing prev', async () => {
        const fileParam: string = [useImage(IMAGE_V12_1), useImage(IMAGE_V13_1), useImage(IMAGE_V14_1)].join(',');

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledTimes(2);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(3); // adds both, relocates first during second processing
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
    });

    it('success with older that is newer than prev', async () => {
        setManifest(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V12_1_METAS]);
        const fileParam: string = [useImage(IMAGE_V14_1), useImage(IMAGE_V13_1)].join(',');

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledTimes(2);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(1);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(1);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
    });

    it('success with newer with missing file', async () => {
        setManifest(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
        const fileParam: string = [useImage(IMAGE_V14_1)].join(',');

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledTimes(2);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(1);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_1_METAS]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, []);
    });

    it('success with multiple different files', async () => {
        const fileParam: string = [useImage(IMAGE_V14_2), useImage(IMAGE_V14_1)].join(',');

        // @ts-expect-error mock
        await updateOtaPR(github, core, context, fileParam);

        expect(readManifestSpy).toHaveBeenCalledTimes(2);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(2); // adds both, relocates first during second processing
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [IMAGE_V14_2_METAS, IMAGE_V14_1_METAS]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, []);
    });

    it('success with extra metas', async () => {
        const fileParam: string = useImage(IMAGE_V14_1);
        const newContext = withBody(`Text before start tag \`\`\`json {"manufacturerName": ["lixee"]} \`\`\` Text after end tag`);

        // @ts-expect-error mock
        await updateOtaPR(github, core, newContext, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(1);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [
            withExtraMetas(IMAGE_V14_1_METAS, {manufacturerName: ['lixee']}),
        ]);
    });

    it('success with all extra metas', async () => {
        const fileParam: string = useImage(IMAGE_V14_1);
        const newContext = withBody(`Text before start tag 
\`\`\`json
{
    "force": false,
    "hardwareVersionMax": 2,
    "hardwareVersionMin": 1,
    "manufacturerName": ["lixee"],
    "maxFileVersion": 5,
    "minFileVersion": 3,
    "modelId": "bogus",
    "releaseNotes": "bugfixes"
}
\`\`\`
Text after end tag`);

        // @ts-expect-error mock
        await updateOtaPR(github, core, newContext, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(1);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [
            withExtraMetas(IMAGE_V14_1_METAS, {
                force: false,
                hardwareVersionMax: 2,
                hardwareVersionMin: 1,
                manufacturerName: ['lixee'],
                maxFileVersion: 5,
                minFileVersion: 3,
                modelId: 'bogus',
                releaseNotes: 'bugfixes',
            }),
        ]);
    });

    it('failure with invalid extra metas', async () => {
        const fileParam: string = useImage(IMAGE_V14_1);
        const newContext = withBody(`Text before start tag \`\`\`json {"manufacturerName": "myManuf"} \`\`\` Text after end tag`);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, newContext, fileParam);
        }).rejects.toThrow(
            expect.objectContaining({message: expect.stringContaining(`Invalid format for 'manufacturerName', expected 'array of string' type.`)}),
        );

        expectNoChanges(true);
        expect(github.rest.issues.createComment).toHaveBeenCalledTimes(1);
    });

    it.each([
        ['fileName'],
        ['originalUrl'],
        ['force'],
        ['hardwareVersionMax'],
        ['hardwareVersionMin'],
        ['manufacturerName'],
        ['maxFileVersion'],
        ['minFileVersion'],
        ['modelId'],
        ['releaseNotes'],
    ])('failure with invalid type for extra meta %s', async (metaName) => {
        const fileParam: string = useImage(IMAGE_V14_1);
        // use object since no value type is ever expected to be object
        const newContext = withBody(`Text before start tag \`\`\`json {"${metaName}": {}} \`\`\` Text after end tag`);

        await expect(async () => {
            // @ts-expect-error mock
            await updateOtaPR(github, core, newContext, fileParam);
        }).rejects.toThrow(expect.objectContaining({message: expect.stringContaining(`Invalid format for '${metaName}'`)}));

        expectNoChanges(true);
        expect(github.rest.issues.createComment).toHaveBeenCalledTimes(1);
    });

    it('success with multiple files and specific extra metas', async () => {
        const fileParam: string = [useImage(IMAGE_V13_1), useImage(IMAGE_V14_1)].join(',');
        const newContext = withBody(`Text before start tag 
\`\`\`json
[
    {"fileName": "${IMAGE_V14_1}", "manufacturerName": ["lixee"], "hardwareVersionMin": 2},
    {"fileName": "${IMAGE_V13_1}", "manufacturerName": ["lixee"]}
]
\`\`\`
Text after end tag`);

        // @ts-expect-error mock
        await updateOtaPR(github, core, newContext, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(2);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [
            withExtraMetas(IMAGE_V14_1_METAS, {manufacturerName: ['lixee'], hardwareVersionMin: 2}),
        ]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [
            withExtraMetas(IMAGE_V13_1_METAS, {manufacturerName: ['lixee']}),
        ]);
    });

    it('success with multiple files and specific extra metas, ignore without fileName', async () => {
        const fileParam: string = [useImage(IMAGE_V13_1), useImage(IMAGE_V14_1)].join(',');
        const newContext = withBody(`Text before start tag 
\`\`\`json
[
    {"fileName": "${IMAGE_V14_1}", "manufacturerName": ["lixee"], "hardwareVersionMin": 2},
    {"manufacturerName": ["lixee"]}
]
\`\`\`
Text after end tag`);

        // @ts-expect-error mock
        await updateOtaPR(github, core, newContext, fileParam);

        expect(readManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME);
        expect(readManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME);
        expect(addImageToBaseSpy).toHaveBeenCalledTimes(2);
        expect(addImageToPrevSpy).toHaveBeenCalledTimes(0);
        expect(writeManifestSpy).toHaveBeenCalledTimes(2);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.BASE_INDEX_MANIFEST_FILENAME, [
            withExtraMetas(IMAGE_V14_1_METAS, {manufacturerName: ['lixee'], hardwareVersionMin: 2}),
        ]);
        expect(writeManifestSpy).toHaveBeenCalledWith(common.PREV_INDEX_MANIFEST_FILENAME, [IMAGE_V13_1_METAS]);
    });
});