llvm / llvm/circt

[Handshake] Structure lit tests cleanly and cover all passes

Open
#4,328 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Handshake
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

Currently, the tests covering handshake operations and passes are incomplete and would profit from a clean restructuring. In general, it seems that most dialect tests are structured differently.

I would suggest following the structure most MLIR dialects implement:
1. `ops.mlir` that simply parses and prints each operation to check if the implemented parsers and printers work correctly
2. `invalid.mlir` that checks all verifications and constraints of the dialect operations
3. `canonicalize.mlir`
4. `PASS.mlir` that tests a pass in isolation
5. `PASS-invalid.mlir` ensures that a pass fails if its preconditions aren't satisfied.

CC @mortbopet

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Locate the existing Handshake dialect tests and compare their organization with tests in other MLIR dialects. Restructure coverage into ops.mlir, invalid.mlir, canonicalize.mlir, pass-specific files, and PASS-invalid.mlir as applicable. Done means parsers, printers, verifications, canonicalization, and pass preconditions are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers, testing-qa
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.