@accordproject/ergo-compiler/test/compiler.js

/*
 * 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.
 */

'use strict';

const ErgoCompiler = require('../lib/compiler');
const Chai = require('chai');

Chai.should();
Chai.use(require('chai-things'));
Chai.use(require('chai-as-promised'));

const Fs = require('fs');
const Path = require('path');

const TESTS_DIR = '../../tests';

describe('ergo-compiler', () => {

    afterEach(() => {});

    describe('#targets', () => {
        it('should return all the compiler targets', () => {
            ErgoCompiler.availableTargets().should.deep.equal(['es6','java']);
        });
        it('es5 should *not* be a valid target', () => {
            (() => ErgoCompiler.isValidTarget('es5')).should.throw('Unknown target: es5 (available: es6,java)');
        });
        it('es6 should be a valid target', () => {
            ErgoCompiler.isValidTarget('es6').should.equal(true);
        });
        it('java should be a valid target', () => {
            ErgoCompiler.isValidTarget('java').should.equal(true);
        });
        it('should not be a valid target', () => {
            (() => ErgoCompiler.isValidTarget('es7')).should.throw('Unknown target: es7 (available: es6,java)');
        });
    });

    describe('#callname', function () {
        it('should sanitize call names for contracts', async function () {
            const contractName = 'org.accordproject.volumediscount.VolumeDiscount';
            const result = await ErgoCompiler.contractCallNamePromise(contractName);
            result.should.equal('orgXaccordprojectXvolumediscountXVolumeDiscount');
        });
    });

    describe('#parsefail', function () {
        it('should fail when Ergo does not parse', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'bad-logic', 'logic/logic.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'bad-logic', 'model/model.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', false);
            result.error.kind.should.equal('ParseError');
            result.error.message.should.equal('Parse error');
            result.error.locstart.should.deep.equal({ 'line' : 17, 'column' : 20 });
            result.error.locend.should.deep.equal({ 'line' : 17, 'column' : 23 });
        });
    });
    describe('#parseerrormessage', function () {
        it('should format parse error', async function () {
            const result = await ErgoCompiler.ergoErrorToString({ 'kind' : 'ParseError', 'message' : 'Parse error', 'fullMessage' : 'Parse error (at file ../../tests/bad-logic/logic/logic.ergo line 17 col 20). \ncontract HelloWorld ovr TemplateModel {\n                    ^^^                ', 'locstart' : { 'line' : 16, 'column' : 25 }, 'locend' : { 'line' : 16, 'column' : 26 } });
            result.should.deep.equal('Parse error');
        });
    });
    describe('#verboseparseerrormessage', function () {
        it('should format fullMessage parse error', async function () {
            const result = await ErgoCompiler.ergoVerboseErrorToString({ 'kind' : 'ParseError', 'message' : 'Parse error', 'fullMessage' : 'Parse error (at file ../../tests/bad-logic/logic/logic.ergo line 17 col 20). \ncontract HelloWorld ovr TemplateModel {\n                    ^^^                ', 'locstart' : { 'line' : 16, 'column' : 25 }, 'locend' : { 'line' : 16, 'column' : 26 } });
            result.should.deep.equal('Parse error (at file ../../tests/bad-logic/logic/logic.ergo line 17 col 20). \ncontract HelloWorld ovr TemplateModel {\n                    ^^^                ');
        });
    });
    describe('#compilationerrormessage', function () {
        it('should format compilation error', async function () {
            const result = await ErgoCompiler.ergoErrorToString({ 'kind' : 'CompilationError', 'message' : 'Import not found: org.accordproject.test', 'locstart' : { 'line' : -1, 'column' : -1 }, 'locend' : { 'line' : -1, 'column' : -1 } });
            result.should.deep.equal('Import not found: org.accordproject.test');
        });
    });
    describe('#compile', function () {
        it('should compile a smart Ergo contract to JavaScript (ES6)', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'helloworld', 'logic/logic.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'helloworld', 'model/model.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', false, false);
            result.success.should.not.be.null;
        });
        it('should compile a smart Ergo contract to JavaScript and print a warning (ES6)', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'helloworldWarning', 'logic/logicWarn.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'helloworldWarning', 'model/model.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', false, true);
            result.success.should.not.be.null;
        });
        it('should compile and link a smart Ergo contract to JavaScript (ES6)', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'helloworld', 'logic/logic.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'helloworld', 'model/model.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', true);
            result.success.should.not.be.null;
        });
    });
    describe('#compilelatedeliveryfail', function () {
        it('should fail when compiling a smart Ergo contract to JavaScript', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'latedeliveryandpenalty2', 'logic/logic.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'latedeliveryandpenalty2', 'model/model2.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', false);
            result.should.deep.equal({ 'error' : { 'kind' : 'CompilationError', 'fileName': null, 'message': 'Import not found: org.accordproject.test', 'fullMessage' : 'Compilation error. Import not found: org.accordproject.test', 'locstart' : { 'line' : -1, 'column' : -1 }, 'locend' : { 'line' : -1, 'column' : -1 } } });
        });
    });
    describe('#compilelatedeliveryandlinkfail', function () {
        it('should fail when compiling and linking a smart Ergo contract to JavaScript', async function () {
            const ergoFile = Path.resolve(TESTS_DIR, 'latedeliveryandpenalty2', 'logic/logic.ergo');
            const ergoContent = Fs.readFileSync(ergoFile, 'utf8');
            const ctoFile = Path.resolve(TESTS_DIR, 'latedeliveryandpenalty2', 'model/model2.cto');
            const ctoContent = Fs.readFileSync(ctoFile, 'utf8');
            const result = await ErgoCompiler.compile([{ 'name': ergoFile, 'content' : ergoContent }], [{ 'name': ctoFile, 'content' : ctoContent }], null, 'es6', true);
            result.should.deep.equal({ 'error' : { 'kind' : 'CompilationError', 'fileName': null, 'message': 'Import not found: org.accordproject.test', 'fullMessage' : 'Compilation error. Import not found: org.accordproject.test', 'locstart' : { 'line' : -1, 'column' : -1 }, 'locend' : { 'line' : -1, 'column' : -1 } } });
        });
    });
    describe('#parsecto', function () {
        it('should parse CTO', async function () {
            const ctoText = Fs.readFileSync(Path.resolve(TESTS_DIR, 'helloworld', 'model/model.cto'), 'utf8');
            const result = ErgoCompiler.parseCTOtoJSON(ctoText);
            result.should.not.be.null;
        });
    });
});