A web based mission control framework.
Go to file
Henry 4674918b4b [Examples] #359 Updated to attempt connection to remote data source and fallback to local if unavailable
Minor change to readme

Fixed JSLint errors

More JSLint errors

[Example] Rems data integration - disabled bundle by default.

[Examples] REMS data integration - added newlines at end of files

[Example] Added time conductor support to REMS data integration

Added caching of results

[Examples] Added domain format to REMS data #359

[Example] #637 Added local proxy to app.js to allow cross-origin requests

Updated readme
2016-02-26 14:03:10 -08:00
docs Merge remote-tracking branch 'github/master' into open450b 2016-01-08 15:36:10 -08:00
example [Examples] #359 Updated to attempt connection to remote data source and fallback to local if unavailable 2016-02-26 14:03:10 -08:00
platform [Frontend] Fixed HTML and CSS for grid-item 2016-01-15 15:33:10 -08:00
protractor [Tests] Comment out failing tests 2015-08-12 11:57:56 -07:00
scripts Regenerated bundles 2016-01-14 17:08:19 -08:00
src [API Refactor] Test legacy bundle registry 2016-01-08 13:38:28 -08:00
.gitignore [Documentation] #220 Fix broken links and strange characters in Developer Guide 2015-11-09 17:11:18 -08:00
app.js [Examples] #359 Updated to attempt connection to remote data source and fallback to local if unavailable 2016-02-26 14:03:10 -08:00
build-docs.sh [Documentation] Update doc build/deployer 2015-08-06 11:46:50 -07:00
circle.yml [Docs] remove dependencies for building docs 2016-01-18 13:54:33 -08:00
CONTRIBUTING.md [Documentation] Simplify Author Checklist 2015-12-04 13:25:20 -08:00
index.html [API] Add a top-level main.js 2016-01-06 10:59:21 -08:00
jsdoc.json [Code Style] Add trailing newline 2015-08-17 15:07:47 -07:00
karma.conf.js [Test] Use PhantomJS to run tests 2016-01-18 13:57:32 -08:00
LICENSES.md [Clocks] Add license, change keys 2015-09-14 16:52:56 -07:00
main.js [Examples] #359 Updated to attempt connection to remote data source and fallback to local if unavailable 2016-02-26 14:03:10 -08:00
package.json [Examples] #359 Updated to attempt connection to remote data source and fallback to local if unavailable 2016-02-26 14:03:10 -08:00
pom.xml [Build] Include examples in build 2016-01-15 11:44:26 -08:00
Procfile [CI] Remove non-existent bundle from procfile 2015-10-16 11:33:42 -07:00
README.md [Docs] remove dependencies for building docs 2016-01-18 13:54:33 -08:00
test-main.js [Test] Use PhantomJS to run tests 2016-01-18 13:57:32 -08:00
test.html [Framework] Update test runner 2015-01-02 18:18:03 -08:00

Open MCT Web

Open MCT Web is a web-based platform for mission operations user interface software.

Bundles

A bundle is a group of software components (including source code, declared as AMD modules, as well as resources such as images and HTML templates) that are intended to be added or removed as a single unit. A plug-in for Open MCT Web will be expressed as a bundle; platform components are also expressed as bundles.

A bundle is also just a directory which contains a file bundle.json, which declares its contents.

The file bundles.json (note the plural), at the top level of the repository, is a JSON file containing an array of all bundles (expressed as directory names) to include in a running instance of Open MCT Web. Adding or removing paths from this list will add or remove bundles from the running application.

Bundle Contents

A bundle directory will contain:

  • bundle.json, the declaration of the bundles contents.
  • A source code directory, named src by convention. This contains all JavaScript sources exposed by the bundle. These are declared as AMD modules.
  • A directory for other resources, named res by convention. This contains all HTML templates, CSS files, images, and so forth to be used within a given bundle.
  • A library directory, named lib by convention. This contains all external libraries used and/or exposed by the bundle.
  • A test directory, named test by convention. This contains all unit tests declared for the bundle, as well as a suite.json that acts as a listing of these dependencies. See the section on unit testing below.

Following these bundle conventions is required, at present, to ensure that Open MCT Web (and its build and tests) execute correctly.

Tests

Tests are written for Jasmine 1.3 and run by Karma. To run:

npm test

The test suite is configured to load any scripts ending with Spec.js found in the src hierarchy. Full configuration details are found in karma.conf.js. By convention, unit test scripts should be located alongside the units that they test; for example, src/foo/Bar.js would be tested by src/foo/BarSpec.js. (For legacy reasons, some existing tests may be located in separate test folders near the units they test, but the naming convention is otherwise the same.)

Test Reporting

When npm test is run, test results will be written as HTML to target/tests. Code coverage information is written to target/coverage.

Functional Testing

The tests described above are all at the unit-level; an additional test suite using Protractor us under development, in the protractor folder.

To run:

  • Install protractor following the instructions above.
  • cd protractor
  • npm install
  • npm run all

Build

Open MCT Web includes a Maven command line build. Although Open MCT Web can be run as-is using the repository contents (that is, by viewing index.html in a web browser), the command line build allows machine-driven verification and packaging.

This build will:

  • Check all sources (excluding those in directories named lib) with JSLint for code style compliance. The build will fail if any sources do not satisfy JSLint.
  • Run the unit test suite.
  • Package the application as a war (web archive) file. This is convenient for deployment on Tomcat or similar. This archive will include sources, resources, and libraries for bundles, as well as the top-level files used to initiate running of the application (index.html and bundles.json).

Run as mvn clean install.

Building Documentation

Open MCT Web's documentation is generated by an npm-based build. It has additional dependencies that may not be available on every platform and thus is not covered in the standard npm install. Ensure your system has libcairo installed and then run the following commands:

  • npm install
  • npm install nomnoml
  • npm run docs

Documentation will be generated in target/docs.

Glossary

Certain terms are used throughout Open MCT Web with consistent meanings or conventions. Any deviations from the below are issues and should be addressed (either by updating this glossary or changing code to reflect correct usage.) Other developer documentation, particularly in-line documentation, may presume an understanding of these terms.

  • bundle: A bundle is a removable, reusable grouping of software elements. The application is composed of bundles. Plug-ins are bundles. For more information, refer to framework documentation (under platform/framework.)
  • capability: An object which exposes dynamic behavior or non-persistent state associated with a domain object.
  • composition: In the context of a domain object, this refers to the set of other domain objects that compose or are contained by that object. A domain object's composition is the set of domain objects that should appear immediately beneath it in a tree hierarchy. A domain object's composition is described in its model as an array of id's; its composition capability provides a means to retrieve the actual domain object instances associated with these identifiers asynchronously.
  • description: When used as an object property, this refers to the human-readable description of a thing; usually a single sentence or short paragraph. (Most often used in the context of extensions, domain object models, or other similar application-specific objects.)
  • domain object: A meaningful object to the user; a distinct thing in the work support by Open MCT Web. Anything that appears in the left-hand tree is a domain object.
  • extension: An extension is a unit of functionality exposed to the platform in a declarative fashion by a bundle. For more information, refer to framework documentation (under platform/framework.)
  • id: A string which uniquely identifies a domain object.
  • key: When used as an object property, this refers to the machine-readable identifier for a specific thing in a set of things. (Most often used in the context of extensions or other similar application-specific object sets.)
  • model: The persistent state associated with a domain object. A domain object's model is a JavaScript object which can be converted to JSON without losing information (that is, it contains no methods.)
  • name: When used as an object property, this refers to the human-readable name for a thing. (Most often used in the context of extensions, domain object models, or other similar application-specific objects.)
  • navigation: Refers to the current state of the application with respect to the user's expressed interest in a specific domain object; e.g. when a user clicks on a domain object in the tree, they are navigating to it, and it is thereafter considered the navigated object (until the user makes another such choice.)
  • space: A name used to identify a persistence store. Interactions with persistence with generally involve a space parameter in some form, to distinguish multiple persistence stores from one another (for cases where there are multiple valid persistence locations available.)