index.test.js

const {run} = require('./index');
import axios from "axios";

// Mock axios and reset after each test
jest.mock("axios");
afterEach(() => {
    jest.clearAllMocks();
});

describe('Grafana Annotation Action Tests', () => {

    // ************************ Input Validation Tests ****************************************
    // ****************************************************************************************
    test('Input Validation: missing all required params', () => {
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.patch).toBeCalledTimes(0);
    });

    test('Input Validation: supplied grafanaHost', () => {
        process.env.INPUT_GRAFANAHOST = 'something';
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.patch).toBeCalledTimes(0);
    });

    test('Input Validation: supplied grafanaToken', () => {
        process.env.INPUT_GRAFANAHOST = 'something';
        process.env.INPUT_GRAFANATOKEN = 'something';
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.patch).toBeCalledTimes(0);
    });

    test('Input Validation: supplied grafanaText, satisfied minimum required', () => {
        process.env.INPUT_GRAFANAHOST = 'something';
        process.env.INPUT_GRAFANATOKEN = 'something';
        process.env.INPUT_GRAFANATEXT = 'something';
        axios.post.mockImplementation(() => Promise.resolve({ status: 200, data: { id: 1} }));
        run();
        expect(axios.post).toBeCalledTimes(1);
        expect(axios.post).toBeCalledWith(expect.anything(), {
            tags: [],
            text: 'something',
        }, expect.anything());
        expect(axios.patch).toBeCalledTimes(0);
    });


    // ************************ Create Annotation Tests ***************************************
    // ****************************************************************************************
    test('Create Annotation: global annotation with tags', () => {
        process.env.INPUT_GRAFANATAGS = 'tag:something\ntag2:something'
        axios.post.mockImplementation(() => Promise.resolve({ status: 200, data: { id: 1} }));
        run();
        expect(axios.post).toBeCalledTimes(1);
        expect(axios.post).toBeCalledWith(expect.anything(), {
            tags: [
                'tag:something',
                'tag2:something',
            ],
            text: 'something',
        }, expect.anything());
        expect(axios.put).toBeCalledTimes(0);
    });

    test('Create Annotation: new annotation for dashboard but no panel specified', () => {
        process.env.INPUT_GRAFANADASHBOARDID = '12345';
        axios.post.mockImplementation(() => Promise.resolve({ status: 200, data: { id: 1} }));
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.put).toBeCalledTimes(0);
    });

    test('Create Annotation: new annotation for panel but no dashboard specified', () => {
        process.env.INPUT_GRAFANAPANELID = '12345';
        process.env.INPUT_GRAFANADASHBOARDID = undefined;
        axios.post.mockImplementation(() => Promise.resolve({ status: 200, data: { id: 1} }));
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.put).toBeCalledTimes(0);
    });

    test('Create Annotation: new annotation for panel and dashboard', () => {
        process.env.INPUT_GRAFANAPANELID = '12345';
        process.env.INPUT_GRAFANADASHBOARDID = '12345';
        axios.post.mockImplementation(() => Promise.resolve({ status: 200, data: { id: 1} }));
        run();
        expect(axios.post).toBeCalledTimes(1);
        expect(axios.post).toBeCalledWith(expect.anything(), {
            tags: [
                'tag:something',
                'tag2:something',
            ],
            dashboardId: 12345,
            panelId: 12345,
            text: 'something',
        }, expect.anything());
        expect(axios.put).toBeCalledTimes(0);
    });


    // ************************ Annotation Update Tests ***************************************
    // ****************************************************************************************
    test('Update Annotation: update', () => {
        process.env.INPUT_GRAFANAANNOTATIONID = "12345";
        axios.patch.mockImplementation(() => Promise.resolve({ status: 200}));
        run();
        expect(axios.post).toBeCalledTimes(0);
        expect(axios.patch).toBeCalledTimes(1);
        expect(axios.patch).toBeCalledWith(expect.anything(), { timeEnd: expect.any(Number) }, expect.anything());
    });
});