Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Add initial setup for Spec of Specs generator #4063

Merged
merged 4 commits into from
Aug 13, 2019
Merged

Conversation

2snEM6
Copy link
Contributor

@2snEM6 2snEM6 commented Aug 9, 2019

This PR introduces a draft initial setup to approach Spec of Specs test generators.

The purpose of this PR is to setup the structure for a future implementation and for that reason, sample generators have been added.

Please note that as for now, those generators under (generators) folder may contain bugs or inconsistencies.

image

Note: Header includes common properties for all generator outputs:

  • title
  • summary
  • config
  • runner
  • handler
  • test_cases (the content is independent to each suite)

The following folder structure has been created under the root repo folder.

- generators
	- base_generator.js
	- type_name
		- README.md
		- index.js

- generator_outputs (tmp default format)
	- type_name
		- handler_name.json

- config
	- network_name.json

- utils (common logic)

How to manually test it?

$ cd protocol-specs
$ nom run generate-all-specs

This will create a folder generator_outputs where you will be able to find all the test suites.

Review checklist

  • The PR resolves #INSERT_ISSUE_NUMBER
  • All new code is covered with unit tests
  • Relevant integration / functional tests are added
  • Commit messages follow the commit guidelines
  • Documentation has been added/updated

@2snEM6 2snEM6 self-assigned this Aug 9, 2019
@2snEM6 2snEM6 marked this pull request as ready for review August 9, 2019 12:54
Copy link
Collaborator

@shuse2 shuse2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably I made the confusion, but if it's standalone, base branch can be development

protocol-specs/package.json Outdated Show resolved Hide resolved
protocol-specs/package.json Outdated Show resolved Hide resolved
protocol-specs/package.json Outdated Show resolved Hide resolved
protocol-specs/.prettierrc.json Outdated Show resolved Hide resolved
protocol-specs/.prettierignore Outdated Show resolved Hide resolved
protocol-specs/.eslintrc.json Show resolved Hide resolved
protocol-specs/.eslintignore Show resolved Hide resolved
@nazarhussain
Copy link
Contributor

nazarhussain commented Aug 9, 2019

@limiaspasdaniel @shuse2 Suggestion: If we keep the specs of specs inside same repo as formal implementation, then we may be using same implementation to generate specs (data sets) for those specs(acceptance criteria).

Would be nice if we completely it separate and keep far away from implementation.

@shuse2
Copy link
Collaborator

shuse2 commented Aug 9, 2019

@nazarhussain I agree it would be better to separate the repository.
I think we can separate the repository in the future, as it would be easier for now to manage everything in one repo.

@shuse2 shuse2 changed the base branch from 3955-add_integration_setup to development August 13, 2019 10:45
@shuse2 shuse2 merged commit 68e8e97 into development Aug 13, 2019
@shuse2 shuse2 deleted the spec_of_specs branch August 13, 2019 15:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants