TestUp 2 for SketchUp
Switch branches/tags
Clone or download
Latest commit b189149 Sep 24, 2018
Permalink
Failed to load latest commit information.
.idea Update RubyMine project. Apr 11, 2018
.vscode Configure Solargraph for VSCode. Jun 18, 2018
dialogs Account for Preferences removing tabs. Sep 12, 2018
docs Update README screenshot. Fixes #155. Sep 24, 2018
media/icons Add vector toolbar icons. Sep 10, 2018
ruby-c-extension/sketchup-taskbarlist Add Ruby 2.5 headers and libs for Windows. Sep 3, 2018
skippy/commands Address RuboCop warnings. Sep 11, 2018
src Account for Preferences removing tabs. Sep 12, 2018
tests Refactor how subclasses of TestUp::TestCase is found. Sep 11, 2018
tools Add build script. Fixes #150 Jun 20, 2018
.babelrc Trying to set up Babel for ES5 transpile and polyfill. Ref #111. Jun 8, 2018
.editorconfig Add .editorconfig Apr 11, 2018
.gitignore Add Ruby 2.5 headers and libs for Windows. Sep 3, 2018
.rubocop.yml Address RuboCop warnings. Sep 11, 2018
.rubocop_todo.yml Address RuboCop warnings. Sep 11, 2018
.solargraph.yml Configure Solargraph for VSCode. Jun 18, 2018
Gemfile Address RuboCop warnings. Sep 11, 2018
LICENSE Added copyright and MIT license information. Fixes #74. Aug 15, 2014
README.md Merge branch 'dev-vue' Sep 24, 2018
package-lock.json Update node modules. Sep 24, 2018
package.json Update node modules. Sep 24, 2018
skippy.json Add vector toolbar icons. Sep 10, 2018
test_config_example.yml Base for CI API. Sep 3, 2018
tsconfig.json Prevent context menu and selection in dialogs. Fixes #29. Jun 19, 2018
webpack.config.js Base for Preferences dialog using Vue. Ref #126. Jun 11, 2018

README.md

TestUp 2 for SketchUp

TestUp is a wrapper on top of the minitest gem. It allow SketchUp Extension developers to write minitest tests that runs within SketchUp.

Requirements

  1. SketchUp 2014 or newer.

Setup for Extension Developers

Easy: Download RBZ from the Releases tab on GitHub.

Latest: Install TestUp from git source (See Setup for Contributing). Requires Node to build webdialog content before 2.3+ versions can be used.

Check out the wiki for details on creating tests. Make sure to also refer to minitest documentation.

Examples of extension projects implementing TestUp tests:

Setup for Contributing/Running from Source

TestUp require NodeJS to build webdialog resources: https://nodejs.org/en/ (Version 10.4 was used to build TestUp 2.3)

  1. Fork the project to your own GitHub account. This is important so that we can do code review on changes done. Do not push directly to the main repository.

  2. Clone your fork to your computer.

  3. Open a command line at the project root:

    1. npm install
    2. npm run build

    You can also use npm run build -- --watch to automatically rebuild whenever files changes.

  4. Add a helper Ruby file in your Plugins folder:

# load_testup.rb
# This adds the source directory to Ruby's search path and
# loads TestUp 2.
$LOAD_PATH << "C:/Users/YourUserName/Documents/testup-2/src"
require "testup.rb"

Optionally you can download a RBZ from the Releases tab on GitHub. Beware that this might not be always up to date. Setting up from git is recommended in order to easily keep up to date.

Setup for SketchUp Internal Development

Follow the same steps as for "Setup for Contributing".

In order to load tests from our source code the paths where our tests are needs to be updated. This is done from the Preference dialog found under the TestUp dialog.

Click the gear symbol and you should see a list of paths. By default these will be pointing to the git repository's copy of our tests.

Packaging RBZ for Release

To package an RBZ from the content of the src directory run: (This assumes the binary libraries and webdialog resources have been built.)

npm run package

To build webdialogs and package in a single command:

npm run release

The RBZ appear in a generated archive directory in the project root.

Logging and Re-running

TestUp will log the details of a test-run. These can be found by using the menu Extensions > TestUp > Open Log Folder.

In there you will find .log and .run files.

The .log files are for human reading, containing information about the environment and what tests ran.

The .run files are JSON files which can be used to re-play a test-run. From the TestUp main dialog, click the Re-run... button and select the .run file you are interested in. This will re-run the exact same tests with the same seed so they are also run in the same order.

If you need to re-run a particular run several times you can use Extensions > TestUp > Saved Runs > Add Run. Then you can pick it from the drop-down after choosing Extensions > TestUp > Saved Runs > Set Re-play Run.

Running from Terminal

Running a Full Suite

 "C:\Program Files\SketchUp\SketchUp 2018\SketchUp.exe" -RubyStartupArg "TestUp:CI:Path: C:\Users\Thomas\SourceTree\TestUp2\tests\TestUp UI Tests" > results.json

In the example above TestUp will run a test suite given its path.

Running with Custom Config

# Config.yml
# Required:
Path: C:\Users\Thomas\SourceTree\TestUp2\tests\TestUp UI Tests
# Optional: (By default, don't include a fixed seed!)
Seed: 123 # The seed number for the random order of execution of the tests
# List the set of sets you want to run.
#   Run all tests in test case: TC_TestCaseName#
#   Run specific test: TC_TestCaseName#test_testname
Tests:
- TC_TestSamples#
- TC_TestErrors#test_pass
- TC_TestErrors#test_skip
 "C:\Program Files\SketchUp\SketchUp 2018\SketchUp.exe" -RubyStartupArg "TestUp:CI:Config: \Full\Path\To\Config.yml" > results.json

Troubleshooting

MiniTest

If you should get errors that relate to failing to install MiniTest then you can attempt to install manually from a backup copy in this GitHub repository:

# From the SketchUp Ruby Console:
Gem.install('/path/to/repo/testup-2/gems-backup/minitest-5.4.3.gem')
# Then restart SketchUp.

Credits

Thanks 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. http://www.famfamfam.com/lab/icons/silk/

License

The MIT License (MIT)

See the LICENSE file for details.