SponsorBlockServer/test/cases/generateVerifyToken.ts

import assert from "assert";
import { config } from "../../src/config";
import axios from "axios";
import { createAndSaveToken, TokenType } from "../../src/utils/tokenUtils";
import MockAdapter from "axios-mock-adapter";
let mock: MockAdapter;
import * as patreon from "../mocks/patreonMock";
import * as gumroad from "../mocks/gumroadMock";
import { client } from "../utils/httpClient";
import { validateLicenseKeyRegex } from "../../src/routes/verifyToken";

const generateEndpoint = "/api/generateToken";
const getGenerateToken = (type: string, code: string | null, adminUserID: string | null) => client({
    url: `${generateEndpoint}/${type}`,
    params: { code, adminUserID }
});

const verifyEndpoint = "/api/verifyToken";
const getVerifyToken = (licenseKey: string | null) => client({
    url: verifyEndpoint,
    params: { licenseKey }
});

let patreonLicense: string;
let localLicense: string;
const gumroadLicense = gumroad.generateLicense();

const extractLicenseKey = (data: string) => {
    const regex = /([A-Za-z0-9-]{5}-[A-Za-z0-9-]{5})/;
    const match = data.match(regex);
    if (!match) throw new Error("Failed to extract license key");
    return match[1];
};

describe("generateToken test", function() {

    before(function() {
        mock = new MockAdapter(axios, { onNoMatch: "throwException" });
        mock.onPost("https://www.patreon.com/api/oauth2/token").reply(200, patreon.fakeOauth);
    });

    after(function () {
        mock.restore();
    });

    it("Should be able to create patreon token for active patron", function (done) {
        mock.onGet(/identity/).reply(200, patreon.activeIdentity);
        if (!config?.patreon) this.skip();
        getGenerateToken("patreon", "patreon_code", "").then(res => {
            patreonLicense = extractLicenseKey(res.data);
            assert.ok(validateLicenseKeyRegex(patreonLicense));
            done();
        }).catch(err => done(err));
    });

    it("Should create patreon token for invalid patron", function (done) {
        mock.onGet(/identity/).reply(200, patreon.formerIdentityFail);
        if (!config?.patreon) this.skip();
        getGenerateToken("patreon", "patreon_code", "").then(res => {
            patreonLicense = extractLicenseKey(res.data);
            assert.ok(validateLicenseKeyRegex(patreonLicense));
            done();
        }).catch(err => done(err));
    });

    it("Should be able to create new local token", function (done) {
        createAndSaveToken(TokenType.local).then((licenseKey) => {
            assert.ok(validateLicenseKeyRegex(licenseKey[0]));
            localLicense = licenseKey[0];
            done();
        }).catch(err => done(err));
    });

    it("Should return 400 if missing code parameter", function (done) {
        getGenerateToken("patreon", null, "").then(res => {
            assert.strictEqual(res.status, 400);
            done();
        }).catch(err => done(err));
    });

    it("Should return 403 if missing adminuserID parameter", function (done) {
        getGenerateToken("local", "fake-code", null).then(res => {
            assert.strictEqual(res.status, 403);
            done();
        }).catch(err => done(err));
    });

    it("Should return 403 for invalid adminuserID parameter", function (done) {
        getGenerateToken("local", "fake-code", "fakeAdminID").then(res => {
            assert.strictEqual(res.status, 403);
            done();
        }).catch(err => done(err));
    });
});

describe("verifyToken static tests", function() {
    it("Should fast reject invalid token", function (done) {
        getVerifyToken("00000").then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(!res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should return 400 if missing code token", function (done) {
        getVerifyToken(null).then(res => {
            assert.strictEqual(res.status, 400);
            done();
        }).catch(err => done(err));
    });
});

describe("verifyToken mock tests", function() {

    beforeEach(function() {
        mock = new MockAdapter(axios, { onNoMatch: "throwException" });
        mock.onPost("https://www.patreon.com/api/oauth2/token").reply(200, patreon.fakeOauth);
    });

    afterEach(function () {
        mock.restore();
    });

    it("Should accept current patron", function (done) {
        if (!config?.patreon) this.skip();
        mock.onGet(/identity/).reply(200, patreon.activeIdentity);
        getVerifyToken(patreonLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should reject nonexistent patron", function (done) {
        if (!config?.patreon) this.skip();
        mock.onGet(/identity/).reply(200, patreon.invalidIdentity);
        getVerifyToken(patreonLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(!res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should accept qualitying former patron", function (done) {
        if (!config?.patreon) this.skip();
        mock.onGet(/identity/).reply(200, patreon.formerIdentitySucceed);
        getVerifyToken(patreonLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should reject unqualitifed former patron", function (done) {
        if (!config?.patreon) this.skip();
        mock.onGet(/identity/).reply(200, patreon.formerIdentityFail);
        getVerifyToken(patreonLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(!res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should accept real gumroad key", function (done) {
        mock.onPost("https://api.gumroad.com/v2/licenses/verify").reply(200, gumroad.licenseSuccess);
        getVerifyToken(gumroadLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should reject fake gumroad key", function (done) {
        mock.onPost("https://api.gumroad.com/v2/licenses/verify").reply(200, gumroad.licenseFail);
        getVerifyToken(gumroadLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(!res.data.allowed);
            done();
        }).catch(err => done(err));
    });

    it("Should validate local license", function (done) {
        getVerifyToken(localLicense).then(res => {
            assert.strictEqual(res.status, 200);
            assert.ok(res.data.allowed);
            done();
        }).catch(err => done(err));
    });
});