xref: /arkcompiler/ets_frontend/ets2panda/linter/scripts/update-test-results.mjs

/*
 * Copyright (c) 2023-2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as fs from 'node:fs';
import * as path from 'node:path';

const TS_EXT = ".ts";
const ETS_EXT = ".ets";
const TSX_EXT = ".tsx";
const STS_EXT = ".sts";
const D_TS_EXT = '.d.ts';

class Mode {
    static DEFAULT = 1;
    static AUTOFIX = 2
}

const RESULT_EXT = [];
RESULT_EXT[Mode.DEFAULT] = '.json';
RESULT_EXT[Mode.AUTOFIX] = '.autofix.json';
const AUTOFIX_SKIP_EXT = '.autofix.skip';
const DIFF_EXT = '.diff';
const RESULTS_DIR = 'results'

let testDirs = [];

// forces to update all tests regardless of whether there was diff in a test result
let force_update = false;

for (let arg of process.argv.slice(2)) {
    if (arg === '--force')
        force_update = true;
    else
        testDirs.push(arg);
}

const DEFAULT_COPYRIGHT =  [
    "Copyright (c) 2024 Huawei Device Co., Ltd.",
    "Licensed under the Apache License, Version 2.0 (the 'License');",
    "you may not use this file except in compliance with the License.",
    "You may obtain a copy of the License at",
    "",
    "http://www.apache.org/licenses/LICENSE-2.0",
    "",
    "Unless required by applicable law or agreed to in writing, software",
    "distributed under the License is distributed on an 'AS IS' BASIS,",
    "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
    "See the License for the specific language governing permissions and",
    "limitations under the License."
];

function readTestFile(filePath) {
    try {
        let resultFile = fs.readFileSync(filePath).toString();
        return JSON.parse(resultFile);
    } catch (error) {
        return undefined;
    }
}

function updateTest(testDir, testFile, mode) {
    // Temporary solution: rename '.sts' extension to '.ts'
    if (testFile.endsWith(STS_EXT)) {
        testFile = testFile.replace(STS_EXT, TS_EXT);
    }

    let resultExt = RESULT_EXT[mode];
    let resultFileWithExt = testFile + resultExt;
    let resultFilePath = path.join(testDir, resultFileWithExt);

    // Do not update autofix result if test is skipped
    if (mode === Mode.AUTOFIX && fs.existsSync(path.join(testDir, testFile + AUTOFIX_SKIP_EXT))) {
        return;
    }

    // Update test result when:
    // - '.diff' exists
    // - expected '.json' doesn't exist 
    // - 'force' option is enabled
    if (fs.existsSync(resultFilePath) && !fs.existsSync(path.join(testDir, RESULTS_DIR, resultFileWithExt + DIFF_EXT)) && !force_update) {
        return;
    }

    let expectedResult = readTestFile(resultFilePath);

    const copyright = expectedResult?.copyright ?? DEFAULT_COPYRIGHT;

    let actualResult = readTestFile(path.join(testDir, RESULTS_DIR, resultFileWithExt));
    if (!actualResult || !actualResult.nodes) {
        console.log(`Failed to update ${resultFileWithExt}: couldn't read ACTUAL result file.`);
        return;
    }

    // Write file with actual test results.
    let newResultJSON = JSON.stringify({ copyright, nodes: actualResult.nodes }, null, 4);
    fs.writeFileSync(resultFilePath, newResultJSON);

    console.log(`Updated ${resultFileWithExt}`);
}

for (let testDir of testDirs) {
    if (!fs.existsSync(path.join(testDir, RESULTS_DIR))) continue;

    // Get tests from test directory.
    let testFiles = fs.readdirSync(testDir).filter(x =>
        (x.trimEnd().endsWith(TS_EXT) && !x.trimEnd().endsWith(D_TS_EXT)) ||
        x.trimEnd().endsWith(TSX_EXT) ||
        x.trimEnd().endsWith(ETS_EXT) ||
        x.trimEnd().endsWith(STS_EXT)
    );

    if (!testFiles) continue;

    // Update result for each test for Default and Autofix modes:
    for (let testFile of testFiles) {
        updateTest(testDir, testFile, Mode.DEFAULT);
        updateTest(testDir, testFile, Mode.AUTOFIX);
    }
}