-
Notifications
You must be signed in to change notification settings - Fork 11
Updates and formats Building ISIS #190
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
base: main
Are you sure you want to change the base?
Changes from all commits
bdbcbea
daa3db2
b3f05de
91b5838
b8566b2
991e1b1
e9bf3b1
7ccf06f
99a98c9
b6946a4
d15bff3
f0dc94f
4056f2b
d034fdc
9b69521
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,9 +4,9 @@ | |
|
|
||
| Follow these tutorials to set up your local ISIS environment before you get started: | ||
|
|
||
| 1. [Getting Started With GitHub](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/#getting-started-with-github) | ||
| 2. [Anaconda and ISIS3 Dependencies](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/#anaconda-and-isis3-dependencies) | ||
| 3. [Building ISIS3](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/#building-isis3) | ||
| 1. [Fork and Clone from GitHub](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md/#fork-and-clone-from-github) | ||
| 2. [Setup Conda Build Env and Dependencies](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md/#build-environment--dependencies) | ||
| 3. [Building ISIS](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md/#building-isis) | ||
|
|
||
| ## 2. Converting Apps and Tests | ||
|
|
||
|
|
@@ -18,9 +18,9 @@ find isis/src/*/apps/ -regex '.*/tsts' | sed 's:[^/]*$::' | |
|
|
||
| Apps that need to be refactored only have *app-name.xml* and *main.cpp*, other than the *Makefile* and other possible folders (like `assets` and `tsts`). Take a look at the [bandtrim](https://github.com/DOI-USGS/ISIS3/tree/dev/isis/src/base/apps/bandtrim) app for example. In comparison, apps that have been updated to fit the gtest suite will have *app-name.xml*, *app-name.cpp*, *app-name.h*, and *main.cpp*, like the [campt](https://github.com/DOI-USGS/ISIS3/tree/dev/isis/src/base/apps/campt) app. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar to the last comment, all changes look good. But bandtrim has been converted to a callable app. We might want to pick another example. An option would be to point to bandtrim before it was converted. See here: |
||
|
|
||
| After finding a suitable app to refactor, follow the steps in [Refactoring ISIS3 Applications](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/writing-isis-tests-with-ctest-and-gtest/#refactoring-isis3-applications) in your selected app. | ||
| After finding a suitable app to refactor, follow the steps in [Refactoring ISIS3 Applications](../../how-to-guides/isis-developer-guides/writing-isis-tests-with-ctest-and-gtest.md/#refactoring-isis-applications) in your selected app. | ||
|
|
||
| To write a new test suite with gtest, follow the steps in [Creating a new test suite](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/writing-isis-tests-with-ctest-and-gtest/#creating-a-new-test-suite). | ||
| To write a new test suite with gtest, follow the steps in [Creating a new test suite](../../how-to-guides/isis-developer-guides/writing-isis-tests-with-ctest-and-gtest.md/#creating-a-new-test-suite). | ||
|
|
||
| A great way to get a grasp on the converting process is by looking at previous examples so here are some PRs: | ||
|
|
||
|
|
@@ -29,13 +29,13 @@ A great way to get a grasp on the converting process is by looking at previous e | |
|
|
||
| ## 3. Run Tests | ||
|
|
||
| Check out [Running Tests](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/#running-tests) to get an idea on how to run your tests. | ||
| Check out [Running Tests](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md/#running-tests) to get an idea on how to run your tests. | ||
|
|
||
| As an example, let's look at the [`skypt` test suite](https://github.com/DOI-USGS/ISIS3/blob/dev/isis/tests/FunctionalTestsSkypt.cpp). You can run the all of `skypt`'s tests with `ctest -R skypt`. Let's say you want to test only the first test case in *FunctionalTestsSkypt.cpp*, run `ctest -R FunctionalTestSkyptDefault`. | ||
|
|
||
| ## 4. Run Coverage Checks and Static Checks | ||
|
|
||
| Check out [Running Tests](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/#checking-test-coverage) to see how coverage and static checks work. | ||
| Check out [Running Tests](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md/#checking-test-coverage) to see how coverage and static checks work. | ||
|
|
||
| If you run a partial test, just look at how coverage changed for the specific class or application you updated. | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.