bellese / test-case-engine Goto Github PK

User Story

As a developer
I'd like to use some sort of test-engine for this code
So that I can test my code.

Acceptance Criteria

• Golang testing framework identified.
• Previously identified framework implemented.
• Test-cases written to at least 50% coverage.
• Code coverage can be ingested by SonarQube.

Notes

If steps need to be added for SonarQube integration that should be noted in the documentation.

User Story

As a developer
I'd like to create detailed README's and user documentation
So that I can pass this off to users so they can use it.

Acceptance Criteria

• README's created/updated to explain the usage of the project
• PR merged to master with the above changes

User Story

As a developer
I'd like to ingest YAML and call the correct output script
So that I can generate output test cases

Acceptance Criteria

• main calls a defined output script based on YAML input.
• PR merged to master with the above code changes

User Story

As a developer
I'd like to have a clean file structure
So that I can write organized, clean code.

Acceptance Criteria

• A project structure that adheres to Golang and git best practices
• PR merged to master with the above changes

User Story

As a developer
I'd like to create a JSON output script
So that I can generate JSON test-cases

Acceptance Criteria

• A script written in Golang that will generate JSON data based on YAML input.
• PR merged to master with the above change

User Story

As a developer
I'd like to create a SQL output script
So that I can generate SQL test-cases

Acceptance Criteria

• A script written in Golang that will generate SQL data based on YAML input.
• PR merged to master with the above change

User Story

As a developer
I'd like to have a Dockerfile or docker-compose file for SonarQube
So that I can easily run SonarQube against my code for quality analysis.

Acceptance Criteria

• Dockerfile or docker-compose.yaml created for SonarQube
• PR merged into master with above changes

Notes

A Dockerfile may be a bit basic for this and won't solve the persistence issue. docker-compose.yaml is probably the way to go so the database is retained after shutdown.

User Story

As a developer
I'd like to standardize the YAML format for ingestion
So that I can write clean code to analyze the input YAML.

Acceptance Criteria

• An example YAML added to the repo.
• A PR merged into master with the exampled added.