It performs equality tests on one or many records after the execution of a given Qsim program.

Tests must be defined in a YAML-based string, following this structure.

{ examples: [test1, test2] }

Each individual test consists of a name, preconditions, postconditions and output configuration. Both preconditions and output are optional. If they are not specified, default values will be set.

• Preconditions are values we want our Qsim environment to start with.
• Postconditions are expectations on post-execution record values.
• Output configurations are used to specify which fields will be shown at the end of program.

In the example given below the program sets R0 = AAAA and 0001 = BBBB, and expects that R0 final value is FFFF. Records, flags, special records and memory addresses can be set.

test1 = {
    name: 'R0 should remain unchanged',
    preconditions: {
        R0: 'AAAA',
        0001: 'BBBB'
    },
    postconditions: {
        equal: {
            R0: 'FFFF'
        }
    }
}

Besides from it's default value, output can be modified by tweaking some keys. Each key is tied to one category, and it determines whether the category is displayed or not.

• memory: (false by default) Can be either a range or false
• records: (true by default) Can be either true or false
• flags: (false by default) Can be either true or false
• special_records: (false by default) Can be either true or false

As populating the screen with all of the memory records wouldn't be wise, an address start and end must be declared.

range = { from: '0000', to: 'FFFF' }

Now, let's modify the previous example in order to display only flags, special records and memory from AAAA to BBBB

test1_with_output = {
    name: 'R0 should remain unchanged',
    preconditions: {
        R0: 'AAAA',
        0001: 'BBBB'
    },
    postconditions: {
        equal: {
            R0: 'FFFF'
        }
    },
    output: {
        flags: true,
        records: false,
        special_records: true,
        memory: {
            from: 'AAAA',
            to: 'BBBB'
        }
    }
}

And finally in YAML format:

examples:
  - name: 'R0 should remain unchanged'        
    postconditions:
      equal:
        R0: 'AAAA'
        '0001': 'BBBB' 
    postconditions:
      equal:
        R0: 'FFFF'
    output:
      flags: true
      records: false
      special_records: true
      memory:
        from: 'AAAA'
        to: 'BBBB'

Additional full examples can be found in the integration suite or programs folder

git clone https://github.com/mumuki/mumuki-qsim-server 
cd mumuki-qsim-server

rbenv install 2.3.1
rbenv rehash
gem install bundler

bundle install

RACK_ENV=development bundle exec rackup -p 4567