kk578 / umlaut Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 519 KB

License: Other

JavaScript 83.29% C# 15.97% Java 0.73%

umlaut's Introduction

UMLAUT

This project is part of a submission for the MEng Degree in Computer Science at UCL (University College London).

Projects in this Repository

UML-Annotator

Tool to annotate Visual Studio UML models.

UML-Parser

Tool to convert UML models to a standard output for this project.

Output schema:

{
  "className": {
    "name": "Name of class",
    "variables": {
      "variableName": {
        "name": "Name of variable",
        "visibility": "Public/Private",
        "type": "Type of variable"
      },
      /* ...Next variable */
    },

    "methods": {
      "methodName": {
        "name": "Name of method",
        "visibility": "Public/Private",
        "type: "Return type of method",
        "arguments": {
          "argument": "Type of argument",
          /* ...Next argument */
        },

        "preconditions": [
          {
            "id": "UUID for this precondition",
            "comparison": "Comparison name",
            "arguments": [
              "Name of variable or method argument or direct value",
              /* ...Next argument */
            ]
          },
          /* ...Next precondition */
        ],

        "postconditions": [
          {
            "id": "UUID for this postcondition",
            "comparison": "Comparison name",
            "arguments": [
              "Name of variable or method argument or direct value",
              /* ...Next argument */
            ]
          },
          /* ...Next postcondition */
        ]
      },
      /* ...Next method */
    }

  },
  /* ...Next class */
}

For list of comparison names, see comparisons.json.

Input-Generator

Tool to generate inputs for tests.

Extends schema of UML-Parser, with an additional tests array on each method:

{
  "className": {
    ...
    "methods": {
      "methodName": {
        ...
        "tests": [
          {
            "condition": "Text identifying the meaning of the test",
            "arguments: {
              "argument": "Value of argument",
              /* ...Next argument */
            }
          },
          /* ...Next test */
        ]
      },
      /* ...Next method */
    }

  },
  /* ...Next class */
}

In order to generate inputs, the design of this section is for submodules to handle specific types for the test. Currently, only numerical logic is handled by the Input-Generator, though more is planned.

SMT-Solver

The SMT-Solver handles Boolean and Numerical Logic. Implementation is handled via the conversion of the annotated constraints on the methods into Satisfiability Modulo Theorem, SMT. Then by using Microsoft's z3, the constraints are solved to generate values that satisfy the constraints.

Test-Generator

Tool to take the UML model and inputs and generate the test suite.

Installation

This is a project dependent on C# (For UML-Annotator) and Node.js (For UML-Parser, Input-Generator and Test-Generator).
This project also uses ES6 syntax, which requires node version v6.0.0 at minimum.

Please ensure that node and npm are installed and available in your PATH, to correctly run this project.
Also check that node --version matches at least v6.0.0.

Node.js is available here for all major OS platforms.

Installing Locally

To install this project:

git clone https://github.com/KK578/compm091-code.git
cd compm091-code
npm install --production
npm link

This will setup the generator to work locally.

Developing

Dependencies

To develop the project, this project uses grunt.

npm install -g grunt-cli

Setup

git clone https://github.com/KK578/compm091-code.git
cd compm091-code
npm install
npm link

Linting

Ensure changes adhere to the existing coding style.
Check code changes with grunt lint.

Unit tests

To test the project, this project uses mocha, and is setup via grunt test.
For code coverage statistics, this project uses istanbul, and is setup via grunt coverage.

Continuous Integration builds is handled via Travis-CI, and is available here.
Code coverage information is handled via Codecov, and is available here.

License

This project has been templated by generator-kk578.

BSD-3 License

See LICENSE.md for full license text.

umlaut's People

Contributors

Watchers

umlaut's Issues

Use a CFG to parse conditions from original model file

Can use a CFG to more reliably handle pulling data from the model through uml-parser.

Similar to #61.

Write conditions back into class diagram

Write conditions into standardised form into method's pre/post-condition property (Visual Studio) listing.

Rename smt-generator to more input generic

More representative in the future for conditions that may not be solvable just by SMT.
(Generator part of name works, but may be confusing with refactor of test-generator to top level.)

E.g. Input-Generator, Input-Solver, Test-Inputs

Update project description

Input-Generator SMT-Solver support multiple classes

smt-solver does not correctly build items for multiple classes at once.

Overloaded methods

Currently assuming no methods have multiple overloads.
Is this a worthwhile thing to handle?

Generalise pipeline to multiple classes

Currently is hardcoded against building for the SimpleMath test project.

Add test UML Projects to repo

Keep all code used for testing project together and up to date

SimpleMath
IntegerStack

Multiple classes support

Support the generation of tests for multiple classes at once.

Weakly Typed languages

Strength of typing introduces challenges to the parser and test generation.
Assuming only Strongly typed for now.

Evaluate how to handle weakly typed languages later. (Add it to the test suite?)

Create base generator that analyses UML to pass up to language specific generators

Refactor this after #21.

Make list of available comparisons for conditions

Keep this in a config for expanding and so that can reuse in later steps (test-generator).

Create C# Window Form Application

For the first prototype, keep split outside Visual Studio to workaround having to work with Modeling SDK.

CFG Parser for all conditions

Do no prior string manipulation on the conditions, and allow CFG to parse entirely.
Can then remove ----- splitters and leave as empty or just spaces.

Code cleanup

SMT-generator has additional items that should be removed.

Fix inequalities not generating inputs

Z3 requires (not (= a a)), where it is currently being stored as != in the parsed uml.

Give condition a unique ID

Give each pre/post-condition a unique ID.

Assists in solving #2.

Use a CFG to parse values in smt-solver

Using some hacky string manipulation at the current time, where a CFG would be much better suited.

Unit tests for each section

Unit tests:

Annotator
UML-Parser
Input-Generator
Test-Generator

Add expected exceptions

Add an expected exception state to conditions.

UML-Parser needs to split this into a exception property under the condition.
SMT-Generator and Test-Generator already handles this.

Test promise utilities

Test utility objects.

CFG Parser handle entire z3 results

Rework the splitting of results and handle strings directly within the parser.

Fix generated assertion for equalities

Z3 requires = to do equality, whereas programming languages can differ but mostly use ==.

SMT-Solver requires directories to be premade

SMT-Solver should create the folders that the SMT files will be stored in temporarily for passing to Z3.

Parse existing conditions

Read existing conditions into OclCondition object format.

Script build from Annotated UML

Automate all steps into a script call.

User annotates UML -> AnnotatedUML

UML-Parser parses AnnotatedUML into ParsedAnnotatedUML
SMT-Generator reads ParsedAnnotatedUML and creates SMTScript
SMT-Generator runs SMTScript and creates ModelTestInputs
Test-Generator reads ParsedAnnotatedUML and ModelTestInputs and creates TestSuite