Skip to content

Integration tests - Phase 1 #11358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Conversation

zvecr
Copy link
Member

@zvecr zvecr commented Dec 30, 2020

Description

Longer term, it has been decided that building all keyboards is not a maintainable strategy for CI. Instead more effort is to be put into unit tests, and running a subset of scenarios. This PR aims as an initial first pass to encapsulate these "integration" test cases. Rather than tag folders within the keyboard structure, I figured it was cleaner to start a new dedicated folder (however this is totally up for discussion).

First pass is to enable such testing, so that the selection of scenarios can begin to be collated. I imagine a structure that migrates away from the current handwired/onekey with its multiple keymaps and something like

examples/<feature>/<dev_board>/

maybe some structure around software/hardware/driver

TODO:

  • it folder name, e2e/integration/? Going with examples per discord discussion
  • work out better magic for make/qmk cli (right now its a bodge with KEYBOARD_DIR=it make onekey:default)

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@zvecr

This comment has been minimized.

@zvecr zvecr mentioned this pull request Dec 31, 2020
14 tasks
@zvecr zvecr force-pushed the feature/integration_tests branch from 47e3152 to f865413 Compare January 2, 2021 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant