Tracking: Test generator MVP

Open
#631 2 comments 1 reaction 1 assignee View on GitHub

@mk-mxp is already working on this.

Since Feb 23, 2024.

Assessment

This issue has not been assessed yet.

Description

Test generator MVP to use after configlet generate for practice exercises:

  • #638 Integrate POC test generator into new directory contrib/generator, so it is not installed in CI
  • #638 Add a parameter to choose the exercise by slug
  • #638 Use local configlet cached problem specification repository as information source
  • #663 Do not do anything, if exercise has no canonical-data (there are some)
  • #663 Use /exercises/practice/${slug}/.meta/config.json>files>test and check that there is only one entry
  • #638 Write tests to already created /exercises/practice/${slug}
  • #638 Have test class skeleton
  • #663 Have test class DocBlock with "PHP track rules"
  • #638 Have testdox with description
  • #638 Have UUID in DocBlock
  • #638 Have all tests marked incomplete
  • #663 Have $input, $expected
  • #663 Have $subject = new ${PascalSlug};, $actual = $subject->${property}($input); and assertSame($expected, $actual);
  • #663 Handle unknown data, so the user can act on it
  • #663 Handle nested groups of tests
  • Bonus: Add composer script to handle exercise generation from scratch. The problem is handling the slug required for exercise generation. That requires some additional scripting, so that only those commands get the slug that need it and the others do not fail.
  • #663 adds unit tests, but no integration tests Bonus: Add golden tests for test generation of some exercises
  • #663 handles unknow data instead Bonus: Add JSON validation using the configlet scheme (if that exists), else at least field existance and character sets
  • Bonus: Add PHP CodeSniffer (with rules for test-generator only) and more static analysis

Not MVP:

Open questions:

  • Should it be a single command app or do we want to add more commands like update-exercise (or so)?
  • Should we use another code producer library like laminas/laminas-code?
Dominant language
PHP
Stars
167
Forks
151
Avg merge
2d 6h
Merged PRs (30d)
8

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from exercism/php

All issues in exercism/php

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.