{"id":13901241,"url":"https://github.com/SketchUp/testup-2","last_synced_at":"2025-07-17T21:32:55.169Z","repository":{"id":13265924,"uuid":"15951247","full_name":"SketchUp/testup-2","owner":"SketchUp","description":"TestUp 2 for SketchUp - A GUI wrapper for running Minitest in SketchUp","archived":false,"fork":false,"pushed_at":"2024-02-27T10:41:07.000Z","size":22145,"stargazers_count":25,"open_issues_count":41,"forks_count":36,"subscribers_count":19,"default_branch":"main","last_synced_at":"2024-04-14T13:14:44.087Z","etag":null,"topics":["extension","ruby","sketchup","testing"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SketchUp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-01-15T22:48:36.000Z","updated_at":"2024-06-20T22:33:10.998Z","dependencies_parsed_at":"2024-06-20T22:32:50.895Z","dependency_job_id":"5ce57e91-4df1-493e-8adf-3b62346c52fa","html_url":"https://github.com/SketchUp/testup-2","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/SketchUp/testup-2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchUp%2Ftestup-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchUp%2Ftestup-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchUp%2Ftestup-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchUp%2Ftestup-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SketchUp","download_url":"https://codeload.github.com/SketchUp/testup-2/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SketchUp%2Ftestup-2/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265663011,"owners_count":23807465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["extension","ruby","sketchup","testing"],"created_at":"2024-08-06T21:01:04.066Z","updated_at":"2025-07-17T21:32:50.157Z","avatar_url":"https://github.com/SketchUp.png","language":"Ruby","readme":"# TestUp 2 for SketchUp\n\nTestUp is a wrapper on top of the [minitest](https://github.com/seattlerb/minitest) gem. It allow SketchUp Extension developers to write `minitest` tests that runs within SketchUp.\n\n![](docs/overview.png)\n\n## Requirements\n\n1. SketchUp 2017 or newer. (For SketchUp 2014-2016, use [TestUp 2.4](https://github.com/SketchUp/testup-2/releases/tag/2.4.2))\n\n## Setup for Extension Developers\n\nEasy: Download RBZ from the [Releases tab on GitHub](https://github.com/SketchUp/testup-2/releases).\n\nLatest: Install TestUp from `git` source (See Setup for Contributing). Requires [Node](https://nodejs.org) to build webdialog content before 2.3+ versions can be used.\n\nCheck out the [wiki](https://github.com/SketchUp/testup-2/wiki) for details on creating tests. Make sure to also refer to [minitest documentation](http://docs.seattlerb.org/minitest/).\n\nExamples of extension projects implementing TestUp tests:\n* https://bitbucket.org/thomthom/quadface-tools/src\n* https://github.com/thomthom/shadow-texture/tree/dev-vscode-debug\n\n## Setup for Contributing/Running from Source\n\nTestUp require [NodeJS](https://nodejs.org) to build webdialog resources: https://nodejs.org/en/ (Version 10.4 was used to build TestUp 2.3-2.5)\n\n1. Fork the project to your own GitHub account. This is important so that we can do code review on changes done.\n_Do **not** push directly to the main repository._\n\n2. Clone your fork to your computer.\n\n3. Open a command line at the project root:\n    1. `npm install`\n    2. `npm run build`\n\n    You can also use `npm run build -- --watch` to automatically rebuild whenever files changes.\n\n4. Add a helper Ruby file in your Plugins folder:\n\n```ruby\n# load_testup.rb\n# This adds the source directory to Ruby's search path and\n# loads TestUp 2.\n$LOAD_PATH \u003c\u003c \"C:/Users/YourUserName/Documents/testup-2/src\"\nrequire \"testup.rb\"\n```\n\nOptionally you can download a RBZ from the [Releases tab on GitHub](https://github.com/SketchUp/testup-2/releases). Beware that this might not be\nalways up to date. Setting up from git is recommended in order to easily keep\nup to date.\n\n## Setup for SketchUp Internal Development\n\nFollow the same steps as for \"Setup for Contributing\".\n\nIn order to load tests from our source code the paths where our tests are\nneeds to be updated. This is done from the Preference dialog found under the\nTestUp dialog.\n\nClick the gear symbol and you should see a list of paths. By default these will\nbe pointing to the git repository's copy of our tests.\n\n## Packaging RBZ for Release\n\nTo package an RBZ from the content of the `src` directory run:\n(This assumes the binary libraries and webdialog resources have been built.)\n\n```\nnpm run package\n```\n\nTo build webdialogs and package in a single command:\n\n```\nnpm run release\n```\n\nThe RBZ appear in a generated `archive` directory in the project root.\n\n## Logging and Re-running\n\nTestUp will log the details of a test-run. These can be found by using the menu\n`Extensions \u003e TestUp \u003e Open Log Folder`.\n\nIn there you will find `.log` and `.run` files.\n\nThe `.log` files are for human reading, containing information about the\nenvironment and what tests ran.\n\nThe `.run` files are JSON files which can be used to re-play a test-run. From\nthe TestUp main dialog, click the `Re-run...` button and select the `.run` file\nyou are interested in. This will re-run the exact same tests with the same seed\nso they are also run in the same order.\n\nIf you need to re-run a particular run several times you can use\n`Extensions \u003e TestUp \u003e Saved Runs \u003e Add Run`. Then you can pick it from the\ndrop-down after choosing `Extensions \u003e TestUp \u003e Saved Runs \u003e Set Re-play Run`.\n\n## Running from Terminal\n\n### Running a Full Suite\n\nWindows:\n```sh\n \"C:\\Program Files\\SketchUp\\SketchUp 2023\\SketchUp.exe\" -RubyStartupArg \"TestUp:CI:Path: C:\\Users\\Thomas\\SourceTree\\TestUp2\\tests\\TestUp UI Tests\" \u003e results.json\n```\n\nmacOS:\n```\n'/Applications/SketchUp 2023/SketchUp.app/Contents/MacOS/sketchup' -RubyStartupArg 'TestUp:CI:Path: C:/Users/Thomas/SourceTree/TestUp2/tests/TestUp UI Tests' \u003e results.json\n```\n\nIn the example above TestUp will run a test suite given its path. The ` \u003e results.json` will redirect the STDOUT to a file which will contain the JSON results of the test run.\n\n### Running with Custom Config\n\n```yml\n# Config.yml\n# Required:\nPath: C:\\Users\\Thomas\\SourceTree\\TestUp2\\tests\\TestUp UI Tests\n\n# Optional: (By default, don't include a fixed seed!)\nSeed: 123 # The seed number for the random order of execution of the tests\n\n# Optional:\n# By default the results will be output to STDOUT. This can be redirected to a\n# file.\nOutput: C:\\Users\\Thomas\\SourceTree\\TestUp2\\tests\\results.json\n\n# Optional:\n# Overriding where the .log files from a test run will be saved.\nLogPath: C:\\Users\\Thomas\\SourceTree\\TestUp2\\logs\n\n# Optional:\n# Path to a .log file that will be used if TestUp itself runs into any errors\n# while running the tests.\nErrorLogPath: C:\\Users\\Thomas\\SourceTree\\TestUp2\\testup_errors.log\n\n# Optional:\n# Overriding where the .run files from a test run will be saved.\nSavedRunsPath: C:\\Users\\Thomas\\SourceTree\\TestUp2\\logs\n\n# Optional:\n# Set to true to prevent SketchUp from closing. Useful for debugging purposes.\n# Note that if `Output` is used the results won't be written until SketchUp is\n# closed.\nKeepOpen: false\n\n# Optional:\n# List the set of sets you want to run.\n#   Run all tests in test case: TC_TestCaseName#\n#   Run specific test: TC_TestCaseName#test_testname\nTests:\n- TC_TestSamples#\n- TC_TestErrors#test_pass\n- TC_TestErrors#test_skip\n```\n\nWindows:\n```sh\n\"C:\\Program Files\\SketchUp\\SketchUp 2023\\SketchUp.exe\" -RubyStartupArg \"TestUp:CI:Config: \\Full\\Path\\To\\Config.yml\"\n```\n\nmacOS:\n```sh\n'/Applications/SketchUp 2023/SketchUp.app/Contents/MacOS/sketchup' -RubyStartupArg 'TestUp:CI:Config: /Full/Path/To/Config.yml'\n```\n\n### Configuration File Variables\n\n#### `%CONFIG_DIR%`\n\nExpands to the directory where the configuration file is located.\n\nGiven a configuration file located at `C:/Users/Thomas/SourceTree/TestUp2/testup-ui-ci.yaml` then `%CONFIG_DIR%` will resolve to `C:/Users/Thomas/SourceTree/TestUp2`.\n\n```yml\n# testup-ui-ci.yaml\nPath: \"%CONFIG_DIR%/tests/TestUp UI Tests\"\nOutput: \"%CONFIG_DIR%/tests/ui-tests-results.json\"\n```\n\n## Troubleshooting\n\n### Minitest\n\nIf you should get errors that relate to failing to install Minitest then you\ncan attempt to install manually from a backup copy in this GitHub repository:\n\n```ruby\n# From the SketchUp Ruby Console:\nGem.install('/path/to/repo/testup-2/gems/minitest-5.15.0.gem')\n# Then restart SketchUp.\n```\n\n## Credits\n\nThanks to Mark James for making his excellent icon set \"Silk\" available. Portions of the set is used in this project. Some file names has been renamed and some icons where mixed to create new status indicators for test result.\nhttp://www.famfamfam.com/lab/icons/silk/\n\n## License\n\nThe MIT License (MIT)\n\nSee the LICENSE file for details.\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSketchUp%2Ftestup-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSketchUp%2Ftestup-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSketchUp%2Ftestup-2/lists"}