SPECTEST ROADMAP

[nao1215]

Introduction

The spectest is a package forked from steinfletcher/apitest. The apitest has the functionality to generate HTML documents from end-to-end test results, and the development of spectest was initiated to enhance this feature.

One month after the fork, spectest has added the capability to output documents in markdown format (I have also conducted refactoring). While there are several feature ideas, developing them alone would be time-consuming.

Therefore, I have decided to clearly outline spectest's roadmap and record feature ideas as issues. If you are interested in spectest, feel free to implement some of these issues.

Goal

1. Generate Markdown documents from E2E test results to reduce the time developers spend on document creation.
2. Support BDD-style testing methods.
3. Become a versatile library that allows easy writing of unit tests for entities other than APIs.
4. Provide CLI commands to enhance the developer experience during unit test execution.

Roadmap

• Roadmap 1. Refactoring
• Roadmap 2. Adding Functionality to Simplify Unit Testing
• Roadmap 3. Enhancement of Documentation Feature
• Roadmap 4. Creating Mocks for External Systems Such as AWS
• Roadmap 5. Making Spectest Usable for Simple Unit Tests
• Roadmap 6. Creating a Website to Explain How to Use Spectest

Roadmap 1. Refactoring

• update spectest/x/db #18
• Merge projects managed by git submodule into spectest. #25 (This issue is related roadmap 4)
• Fix broken example of github.com/kataras/iris #29
• Switching line feed by OS #34
• Return error instead of using panic #35
• Modifying Data Structures #145
• Adding Documentation Comments and Reducing Function Complexity #146
• Generate CHANGELOG from git commit log #148
• Improving unit test coverage. #164

Roadmap 2. Adding Functionality to Simplify Unit Testing

• Feature: generate golden file #140
• Output error messages in red text　 #141
• Feature to Improve Readability of Test Results Output #162

Roadmap 3. Enhancement of Documentation Feature

• Combine the documents (HTML) into one. #100
• Feature: markdown indexing #139
• spectest index command standard outputs the index markdown file path after generated it. #168

Roadmap 4. Creating Mocks for External Systems Such as AWS

• Adding AWS SDK Mock to go-spectest/aws #143
• ??? Adding another service mock such as firebase.

Roadmap 5. Making Spectest Usable for Simple Unit Tests

• Creating Function/Method-Based Sequence Diagrams #97

Roadmap 6. Creating a Website to Explain How to Use Spectest

• Creating a Website to Introduce Spectest Usage #144