@wmfs/tymly-solr-plugin/test/solr-plugin-tests.js

/* eslint-env mocha */

'use strict'

const expect = require('chai').expect
const tymly = require('@wmfs/tymly')
const path = require('path')
const process = require('process')

const sqlScriptRunner = require('./fixtures/sql-script-runner.js')
const studentsModels = require('./fixtures/school-blueprint/models/students.json')
const studentsSearchDocs = require('./fixtures/school-blueprint/search-docs/students.json')

// note that state-machines usually inherit their namespace from the blueprint.json file.
// the studentsAndStaffModels json files have explicitly defined the namespaces as
// they are used by tests as-is, and so tymly will automatically "inherit" it
const studentsAndStaffModels = require('./fixtures/test-resources/students-and-staff-models.json')
const studentsAndStaffSearchDocs = require('./fixtures/test-resources/students-and-staff-search-docs.json')

describe('tymly-solr-plugin tests', function () {
  this.timeout(process.env.TIMEOUT || 5000)

  let tymlyService
  let solrService
  let client

  before(function () {
    if (process.env.PG_CONNECTION_STRING && !/^postgres:\/\/[^:]+:[^@]+@(?:localhost|127\.0\.0\.1).*$/.test(process.env.PG_CONNECTION_STRING)) {
      console.log(`Skipping tests due to unsafe PG_CONNECTION_STRING value (${process.env.PG_CONNECTION_STRING})`)
      this.skip()
    }
  })

  it('should create some basic tymly services', function (done) {
    tymly.boot(
      {
        pluginPaths: [
          path.resolve(__dirname, './../lib'),
          require.resolve('@wmfs/tymly-pg-plugin'),
          require.resolve('@wmfs/tymly-test-helpers/plugins/allow-everything-rbac-plugin')
        ],
        blueprintPaths: [
          path.resolve(__dirname, './fixtures/school-blueprint')
        ],
        config: {
          solrSchemaFields: [
            'id',
            'actorName',
            'characterName'
          ]
        }
      },
      function (err, tymlyServices) {
        expect(err).to.eql(null)
        tymlyService = tymlyServices.tymly
        client = tymlyServices.storage.client
        solrService = tymlyServices.solr
        done()
      }
    )
  })

  it('should generate a SQL SELECT statement', function () {
    const select = solrService.buildSelectStatement(studentsModels, studentsSearchDocs)

    expect(select).to.be.a('string')
    expect(select).to.eql('SELECT \'student#\' || student_no AS id, upper(first_name || \' \' || last_name) AS actor_name, ' +
      'upper(character_name) AS character_name FROM tymly_test.students')
  })

  it('should generate a SQL CREATE VIEW statement', function () {
    const sqlString = solrService.buildCreateViewStatement(
      studentsAndStaffModels, studentsAndStaffSearchDocs)

    expect(sqlString).to.be.a('string')
    expect(sqlString).to.eql('CREATE OR REPLACE VIEW tymly.solr_data AS \n' +
      'SELECT \'student#\' || student_no AS id, first_name || \' \' || last_name AS actor_name, ' +
      'character_name AS character_name FROM tymly_test.students\n' +
      'UNION ALL\n' +
      'SELECT \'staff#\' || staff_no AS id, first_name || \' \' || last_name AS actor_name, ' +
      'character_first_name || \' \' || character_last_name AS character_name FROM tymly_test.staff;')
  })

  it('should have generated a SQL CREATE VIEW statement on tymly boot', function () {
    expect(solrService.createViewSQL).to.be.a('string')
  })

  it('should create test resources', function (done) {
    sqlScriptRunner(
      './db-scripts/setup.sql',
      client,
      err => done(err)
    )
  })

  it('should create a database view using the test resources', function (done) {
    const createViewStatement = solrService.buildCreateViewStatement(
      studentsAndStaffModels, studentsAndStaffSearchDocs)

    client.query(createViewStatement, [], err => done(err))
  })

  it('should return 19 rows when selecting from the view', function (done) {
    client.query(`SELECT * FROM tymly.solr_data ORDER BY character_name ASC;`, [],
      function (err, result) {
        if (err) {
          return done(err)
        }
        try {
          expect(result.rowCount).to.eql(19)
          expect(result.rows[0].id).to.eql('staff#1')
          expect(result.rows[18].id).to.eql('staff#3')
          done()
        } catch (e) {
          done(e)
        }
      }
    )
  })

  // it('should instruct apache solr to index data from the view', function (done) {
  //   solrService.executeSolrFullReindex('addressbase', function (err, solrResponse) {
  //     expect(err).to.eql(null)
  //     if (err) {
  //       debug(err)
  //     } else {
  //       debug('total number of database rows indexed: ', solrResponse.statusMessages['Total Rows Fetched'])
  //     }
  //     done()
  //   })
  // })

  it('should cleanup test resources', function (done) {
    sqlScriptRunner(
      './db-scripts/cleanup.sql',
      client,
      err => done(err)
    )
  })

  it('should shutdown Tymly', async () => {
    await tymlyService.shutdown()
  })
})