Skip to content

Latest commit

 

History

History
215 lines (189 loc) · 7.47 KB

TODO.md

File metadata and controls

215 lines (189 loc) · 7.47 KB
Raw
  • docs: point to new architecture docs from python repo

Test are running on all CI machine

Typing -> Talking -> Next Diana Teresa Joss

We're doing "ping pong style" rotation Rotate on each successful test run, after any smallest improvement to the code in the direction of te agreed upon intention. Rotate on green was designed for git handoff, each commit is green

How do we know that everything works in both Pytest and Unittests?

[ ] Test fail if mariadb is in the requirements for linux

Ping-Pong Pairing Try to make the smallest change possible, then rotate

POssible FEATURE
Create an API to add a REPORTER.test_inline_approvals.py now we have a combined reporter and then ?? only the last one works?

Inline Approvals Bugs 0. [ ] InlineOptions to show diffs

  1. rename all of the reporters to start with the word report
  2. check all reporters return True or False 4. [ ] add mypy to the CI (type hints exist and they are being inforced)
  3. make it so that approvals works with Python 12 4. 2024-04-21 - The issue is in MRJob. Need probably need to move to spark. this should probably be done with Jacqueline present
  4. Improve verify_all for no header Expects VerifyAll to have a header this is mandatory For PYthon Approval Tests added an example to Test_inline_approvals.py see: def test_uppercase_with_verify_all():
  5. expand functionality of parse_doc_string NOTE: this is WIP from 3/3/24 parse inputs 2. [ ] =>, : 3. [ ] maybe not only docstring but any text or approved file? 4. [ ] multiple parameters 1, 2, 3 -> 5. [ ] converter parse(to_integer) 6. [ ] some relationship between the output formatter and the parser 7. [X ] Move explainations to ApprovalTests.Documentation Please note: we found this broken link [Capture .received. files from CI]
    • this link:
  1. disable the CMD key in this Any Desk (Nitsan suggested)
  2. update Cyber-dojo to have latest version of approvaltests.py and a. [x] verify which version of approval tests is in the new image that we just created
  3. put an example of inline approvals into cyber-dojo
  4. add JQ (nitsan created repo and submitted an issue)

----- older stuff below ---- 2. [ ] run the test 2. [ ] Review what we have done 3. [ ] Clean up so things are ready for production

  1. extract SQL utils
  2. write some docs
  3. use it (as the users will ) Manual regression test
  4. ship the code
    1. explore additional test that will Re-test the way other will use it
  5. copmarison after VCR (video recorder) hybrid of Executable Command
    1. executatble ALONE
    2. VCR (python version of executable command )
    3. use both Executable command and VCR
  6. to consider:
  7. do we want to SPLIT up the Command Executer from the Command Generator Key x = done, - = started

notes:

  1. update Cyber-dojo to have latest version of approvaltests.py and

What have we learned?

  • How does approvals work in cyber-dojo?
  • There are two docker images with python approvals: 1. pytest 2. unittest
  • is the version number important?
  • Does it use the pytest plugin at all? Or just pytest?
  • set up Gitpod

Possible problem: we have linked the Execute command and the _____ when you run it there is the part about how to execute and there is ANOTHER part that shows you the specific command that you ar trying to verify it is not obvious how they are used REALIZATION: Executatlbe command class is an Executable COmmand class and _____ (put it in the chat Lev)

QUESTION How to connect a Jetbrains product to a remote workspace. 5. Mr job - need to be able to test against more than one line in a file.

  1. PR to mobti.me to make ding the default 4. Can we change the paradigm for how we do combinations with data and MRJob?

  2. cyber-dojo bug - received file not being deleted 3

  3. Continuing work on approvals-cli: 5 4. Documentation 5. Adding a binary 6. Smarter namer 7. test improvements - do we have all the tests we need?

  4. Create a self-sufficient mob. 5. Need a reproducible anydesk machine 6. Create other EC2 instances 7. gitpod 8. Llewellyn starts an instance and then someone joins with RDP 9. Less comfortable -Github action that spins up an EC2 instance to launch the existing machine- 6. Need a zoom that anyone can connect to

  5. Logging decorator

  7. Next Week:

    1. do clean up: clean up chain, get all reporters is incomplete, rename diffReporter to default diffReporter
    2. add help message
    3. create intro to reporters docs 2. do a safeguarding for this 3. clean up branch

  8. Python Minimal 2. python parse requirements.prod.extras in minimal.py 4. handle UNKNOWN VERSION situation in setup_utils.py better

  9. In the start project should we have a test that confers that the extras are being loaded directly

    1. What should that test be ? Pairwise, bs4

  10. markdown snippets - regex (?<!(a>.*\n))```py

  11. cached property for Namer.get_config

  12. setup github action to lint

    1. Do we make a github action whose sole purpose is to lint?
    2. Options: Lint passes/fails or autocorrects?
    3. Actions work well when simple. Make a lint.bat and go from there

  13. linter - add flake8 to pycharm and tox

  14. check all uses of default reporter in tests

  15. Fail test if there are duplicate names - pylint ?

  16. add checks to twine in github actions

  17. make code more pythonic (method overloads vs default parameters)

  18. Have Oliver and Emily talk about pytest plugin is intergrated in hypoethesis

  19. templated namer

    1. docs on implementing Approvaltests in CI
    2. file commiter reporter
    3. squence to animated gif writer

  20. Property Tests

    1. eval(any.repr) == any
  def test_mypy(self) -> None:
       try:
           import mypy.api
       except ImportError:
           print("mypy not found")
           self.skipTest("mypy not found")
       stdout, stderr, exit_code = mypy.api.run([
           '--config-file', 'mypy.ini',
           SCRIPT_DIR,
       ])
       self.assertEqual(0, exit_code, "\n\n" + stdout + stderr)
  1. Randomize order of tests in pytest plugin
[mypy]
python_version = 3.8
pretty = True
no_incremental = True
ignore_missing_imports = True

strict = True
    ;;;;;;;;  `strict` enables the following flags:
    ; --check-untyped-defs
    ; --disallow-any-generics
    ; --disallow-incomplete-defs
    ; --disallow-subclassing-any
    ; --disallow-untyped-calls
    ; --disallow-untyped-decorators
    ; --disallow-untyped-defs
    ; --no-implicit-optional
    ; --no-implicit-reexport
    ; --strict-equality
    ; --warn-redundant-casts
    ; --warn-return-any
    ; --warn-unused-configs
    ; --warn-unused-ignores
no_site_packages = True
disallow_any_unimported = True
disallow_any_expr = True
disallow_any_decorated = True
disallow_any_explicit = True
strict_optional = True
warn_no_return = True
warn_unreachable = True

Authors: @claremacrae @objarni @tdpreece @emilybache @rzijp @obestwalter

Co-Authored-By: Susan Fung 38925660+susanfung@users.noreply.github.com

Co-authored-by: Nicholas A. Del Grosso delgrosso.nick@gmail.com Co-Authored-By: jmasonlee 262853+jmasonlee@users.noreply.github.com Co-Authored-By: Bernhard Raml 1769280+SwamyDev@users.noreply.github.com