helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Test the crap out of Dockerized executable

Open gpsaggese opened this issue 9 months ago • 2 comments

We want to:

  1. document what are the dockerized scripts
  2. track if they have a cmd line wrapper (e.g., run\_dockerized\_prettier run the code inside the container, and dockerized\_prettier.py that is the cmd line wrapper)
  3. track the unit tests for the code and for the wrapper
  4. We want to document how to test the code
  5. Finish the testing for all these scripts / dockerized functions

prettier

  • code: hdocker.py::run_dockerized_prettier (this is the code that creates the container and wraps it)
  • script: ./dev_scripts_helpers/documentation/dockerized_prettier.py (this is the script interface)
  • test code test_hdocker.py:: Test_run_dockerized_prettier1 (here we test the code itself)
  • test script: TODO (here we test the script)

markdown_toc

  • code: run_dockerized_markdown_toc
  • script: no need
  • test code: Test_run_markdown_toc1
  • test script: no need

latex

  • code: run_dockerized_latex
  • script: ./dev_scripts_helpers/documentation/dockerized_latex.py
  • test code: no (TODO)
  • test script: yes (Test_dockerized_latex1)

tikz_to_png

  • code: run_dockerized_imagemagick
  • script: ./dev_scripts_helpers/documentation/tikz_to_bitmap.py
  • test code: no (TODO)
  • test script: no (TODO)

llm_transform

  • code: run_dockerized_llm_transform
  • script: dev_scripts_helpers/llms/llm_transform.py
  • test code:
  • test script:

plantuml

  • code: run_dockerized_plantuml
  • script:
  • test code:
  • test script:

mermaid

  • run_dockerized_mermaid
  • code:
  • script:
  • test code:
  • test script:

pandoc

  • run_pandoc.py -> what’s the diff with dockerized_pandoc.py
  • ./dev_scripts_helpers/documentation/dockerized_pandoc.py
  • code:
  • script:
  • test code:
  • test script:

render_images.py

  • code:
  • script:
  • test code:
  • test script:

extract_headers_from_markdown.py

  • code:
  • script:
  • test code:
  • test script:

lint_notes.py

  • code:
  • script:
  • test code:
  • test script:

preprocess_notes.py

  • code:
  • script:
  • test code:
  • test script:

transform_notes.py

  • code:
  • script:
  • test code:
  • test script:

notes_to_pdf

  • code:
  • script:
  • test code:
  • test script:

gpsaggese avatar Mar 25 '25 18:03 gpsaggese

Doc with details: https://docs.google.com/document/d/1kU5YEpBjP5WNHJ3kEvWsJGrrk3z2zTMptTOSnvSYz6s/edit?tab=t.0

Shaunak01 avatar Mar 27 '25 01:03 Shaunak01

Can you rename the Gdoc with the name of this bug like HelpersTask... same as a PR

gpsaggese avatar Mar 27 '25 18:03 gpsaggese

Closing as necessary docker executables tested

Shaunak01 avatar Apr 07 '25 19:04 Shaunak01