| // Copyright (c) 2017, Compiler Explorer Authors |
| // All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are met: |
| // |
| // * Redistributions of source code must retain the above copyright notice, |
| // this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above copyright |
| // notice, this list of conditions and the following disclaimer in the |
| // documentation and/or other materials provided with the distribution. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| // POSSIBILITY OF SUCH DAMAGE. |
| |
| import express from 'express'; |
| |
| import {ApiHandler} from '../../lib/handlers/api.js'; |
| import {StorageNull} from '../../lib/storage/index.js'; |
| import {chai} from '../utils.js'; |
| |
| const languages = { |
| 'c++': { |
| id: 'c++', |
| name: 'C++', |
| monaco: 'cppp', |
| extensions: ['.cpp', '.cxx', '.h', '.hpp', '.hxx', '.c'], |
| }, |
| haskell: { |
| id: 'haskell', |
| name: 'Haskell', |
| monaco: 'haskell', |
| extensions: ['.hs', '.haskell'], |
| }, |
| pascal: { |
| id: 'pascal', |
| name: 'Pascal', |
| monaco: 'pascal', |
| extensions: ['.pas'], |
| }, |
| }; |
| const compilers = [ |
| { |
| id: 'gcc900', |
| name: 'GCC 9.0.0', |
| lang: 'c++', |
| }, |
| { |
| id: 'fpc302', |
| name: 'FPC 3.0.2', |
| lang: 'pascal', |
| }, |
| { |
| id: 'clangtrunk', |
| name: 'Clang trunk', |
| lang: 'c++', |
| }, |
| ]; |
| |
| const compilersLimitedFields = [ |
| { |
| id: 'gcc900', |
| name: 'GCC 9.0.0', |
| }, |
| { |
| id: 'fpc302', |
| name: 'FPC 3.0.2', |
| }, |
| { |
| id: 'clangtrunk', |
| name: 'Clang trunk', |
| }, |
| ]; |
| |
| describe('API handling', () => { |
| let app; |
| |
| before(() => { |
| app = express(); |
| const apiHandler = new ApiHandler( |
| { |
| handle: res => res.send('compile'), |
| handleCmake: res => res.send('cmake'), |
| handlePopularArguments: res => res.send('ok'), |
| handleOptimizationArguments: res => res.send('ok'), |
| }, |
| (key, def) => { |
| switch (key) { |
| case 'formatters': { |
| return 'formatt:badformatt'; |
| } |
| case 'formatter.formatt.exe': { |
| return 'echo'; |
| } |
| case 'formatter.formatt.version': { |
| return 'Release'; |
| } |
| case 'formatter.formatt.name': { |
| return 'FormatT'; |
| } |
| default: { |
| return def; |
| } |
| } |
| }, |
| new StorageNull('/', {}), |
| 'default', |
| ); |
| app.use('/api', apiHandler.handle); |
| apiHandler.setCompilers(compilers); |
| apiHandler.setLanguages(languages); |
| }); |
| |
| it('should respond to plain text compiler requests', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.text; |
| res.text.should.contain('Compiler Name'); |
| res.text.should.contain('gcc900'); |
| res.text.should.contain('GCC 9.0.0'); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON compiler requests', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals(compilers); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON compiler requests with all fields', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers?fields=all') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals(compilers); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON compiler requests with limited fields', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers?fields=id,name') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals(compilersLimitedFields); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON compilers requests with c++ filter', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers/c++') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals([compilers[0], compilers[2]]); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON compilers requests with pascal filter', () => { |
| return chai |
| .request(app) |
| .get('/api/compilers/pascal') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals([compilers[1]]); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to plain text language requests', () => { |
| return chai |
| .request(app) |
| .get('/api/languages') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.text; |
| res.text.should.contain('Name'); |
| res.text.should.contain('c++'); |
| res.text.should.contain('pascal'); |
| // We should not list languages for which there are no compilers |
| res.text.should.not.contain('Haskell'); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| it('should respond to JSON languages requests', () => { |
| return chai |
| .request(app) |
| .get('/api/languages') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals([languages['c++'], languages.pascal]); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| // TODO(supergrecko): re-write this test case |
| it.skip('should list the formatters', () => { |
| if (process.platform !== 'win32') { |
| // Expects an executable called echo |
| return chai |
| .request(app) |
| .get('/api/formats') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| res.body.should.deep.equals([{name: 'FormatT', version: 'Release'}]); |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| } |
| }); |
| it('should not go through with invalid tools', () => { |
| return chai |
| .request(app) |
| .post('/api/format/invalid') |
| .set('Accept', 'application/json') |
| .then(res => { |
| res.should.have.status(422); |
| res.should.be.json; |
| res.body.should.deep.equals({exit: 2, answer: "Unknown format tool 'invalid'"}); |
| }); |
| }); |
| /* |
| it('should not go through with invalid base styles', () => { |
| return chai.request(app) |
| .post('/api/format/formatt') |
| .set('Accept', 'application/json') |
| .set('Content-Type', 'application/json') |
| .send({ |
| base: "bad-base", |
| source: "" |
| }) |
| .then(res => { |
| res.should.have.status(422); |
| res.should.be.json; |
| res.body.should.deep.equals({exit: 3, answer: "Base style not supported"}); |
| }); |
| }); |
| */ |
| it('should respond to plain site template requests', () => { |
| return chai |
| .request(app) |
| .get('/api/siteTemplates') |
| .then(res => { |
| res.should.have.status(200); |
| res.should.be.json; |
| }) |
| .catch(err => { |
| throw err; |
| }); |
| }); |
| }); |