Project Usage Integrity Checker for MagicDraw 18

Documentation

PUIC Presentation (May 2013) (with PUIC installed, available in <md.install.dir>/manual/ProjectUsageIntegrityChecker/PUIC-May2013.pptx)
PUIC Local Migration Supoprt (Dec 2014) (with PUIC installed, available in <md.install.dir>/manual/ProjectUsageIntegrityChecker/PUICLocalMigrationSupport-Dec2014.pptx)

Build Process

See item 9 here

Build Artifacts

PUIC Installable Resource

Maven group=gov.nasa.jpl.cae.magicdraw.plugins Maven name=cae_md18_0_sp5_puic_2.11
PUIC Package Bundle

Maven group=gov.nasa.jpl.cae.magicdraw.packages Maven nameA=cae_md18_0_sp5_puic_2.11

Test plan

1 PUIC Installable Resource or PUIC Package Bundle

1.1 PUIC Installable Resource

Download the PUIC installable resource
Start MD: cae.md.aspectj_scala
MD install the PUIC resource
Restart MD

1.2 PUIC Package Bundle

Download the PUIC package bundle
Start MD: cae.md18_0sp5.puic

2 PUIC Tests

Perform the following tests with 1.1 and 1.2 above.

2.1 Test that PUIC is installed properly

PUIC toolbar should be visible by default
MD Option | Environment should have PUIC properties
Configure the PUIC 'dot' location

2.2 Test that PUIC profile is not mounted by default

Make sure the PUIC toolbar ON/OFF button is "ON"

Open <md.install.dir>/samples/SysML/Introduction to SysML.mdzip

Check that the PUIC is RED.
Check that the PUIC profile is not mounted.

Check the $HOME/.magicdraw-puic-<version>/18.0/magicdraw.log shows something like this:

2016-01-21 17:28:11,096 [AWT-EventQueue-0] ERROR PLUGINS - CAE Project Usage Integrity Checker - Error - ProjectUsage graph is invalid
Project classification: project (private data; nothing shared)
'Introduction to SysML'
SSCAEProjectUsageGraph(Vertices=14, Edges=24, Diagrams=59)
   OK: no illegal teamwork transactions detected
ERROR: this project should have the System/Standard Profile flag set
   OK: no local modules with teamwork project IDs
ERROR: this project is missing 3 direct ProjectUsage mount attachments
   OK: no unresolved ProjectUsage relationships
   OK: no proxies detected
   OK: all projects are available
   OK: all local projects have SSP flag
   OK: all projects have no missing shares
ERROR: 1 projects used from MD's install folder do not have the Standard/System Profile flag set
WARNING: 1 SSP profiles have non-unique names
   OK: all user profiles have unique names
   OK: all profiles have unique URIs
   OK: all packages have unique URIs
   OK: project usage mount relationships are acyclic
ERROR: 13 project usage mount relationships are inconsistent
ERROR: 3 projects are used inconsistently
ERROR: 10 project usage mount relationships are invalid
   OK: all shared package usage constraints are consistent
   OK: all modules & project have consistent shared package classifications

Check that there is no MD validation window open with any PUIC validation errors (because there is no PUIC profile!)

2.3 Test that PUIC properly detects errors

Make sure the PUIC toolbar ON/OFF button is "ON"

Open <md.install.dir>/samples/ProjectUsageIntegrityChecker/INCONSISTENT.mdzip

Check that the PUIC is RED.
Click the PUIC Status button.

Check the $HOME/.magicdraw-puic-<version>/18.0/magicdraw.log shows something like this:

2016-01-21 17:32:10,446 [AWT-EventQueue-0] ERROR PLUGINS - CAE Project Usage Integrity Checker - Error - ProjectUsage graph is invalid
Project classification: project/module hybrid (private data; shared packages)
'INCONSISTENT'
SSCAEProjectUsageGraph(Vertices=3, Edges=2, Diagrams=3)
   OK: no illegal teamwork transactions detected
   OK: no local modules with teamwork project IDs
   OK: no missing direct ProjectUsage mount attachments
   OK: no unresolved ProjectUsage relationships
   OK: no proxies detected
   OK: all projects are available
   OK: all local projects have SSP flag
   OK: all projects have no missing shares
   OK: all local projects used from MD's install folder have the Standard/System Profile flag set
   OK: all SSP profiles have unique names
   OK: all user profiles have unique names
   OK: all profiles have unique URIs
   OK: all packages have unique URIs
   OK: project usage mount relationships are acyclic
   OK: project usage mount relationships are consistent
   OK: all projects are used consistently
   OK: project usage mount relationships are valid
   OK: all shared package usage constraints are consistent
   OK: all DEPRECATED shared packages are used consistently
ERROR: 1 modules/project with shared packages inconsistently classified

Check that the MD Message Window shows something like this:

[2016.01.21::17:32:08]
= Project: file:.../cae.md18_0sp5.puic-<version>/samples/ProjectUsageIntegrityChecker/INCONSISTENT.mdzip ==========================================
[2016.01.21::17:32:08]
ERROR: 1 modules/project with INCONSISTENT shared packages classifications
[2016.01.21::17:32:08]
=> P3 is inconsistently classified within module/project 'INCONSISTENT'
[2016.01.21::17:32:08]
=> P2 is inconsistently classified within module/project 'INCONSISTENT'
[2016.01.21::17:32:08]
=> P1 is inconsistently classified within module/project 'INCONSISTENT'
[2016.01.21::17:32:08]
===========================================

Check that there is an MD validation window titled: "SSCAE ProjectUsage Validation Results"
Check that there is exactly 1 validation error: "Apply <> to 'Data'"

2.4 Test that PUIC properly detects valid propjects

Make sure the PUIC toolbar ON/OFF button is "ON"

Open <md.install.dir>/samples/ProjectUsageIntegrityChecker/Supplier-Client-Example.mdzip

Check that the PUIC is Green.
Click the PUIC Status button.

Check the $HOME/.magicdraw-puic-<version>/18.0/magicdraw.log shows something like this:

2016-01-21 17:42:34,176 [AWT-EventQueue-0] INFO  PLUGINS - CAE Project Usage Integrity Checker - OK - ProjectUsage graph is valid
Project classification: project (private data; nothing shared)
'Supplier-Client-Example'
SSCAEProjectUsageGraph(Vertices=3, Edges=2, Diagrams=8)
   OK: no illegal teamwork transactions detected
   OK: no local modules with teamwork project IDs
   OK: no missing direct ProjectUsage mount attachments
   OK: no unresolved ProjectUsage relationships
   OK: no proxies detected
   OK: all projects are available
   OK: all local projects have SSP flag
   OK: all projects have no missing shares
   OK: all local projects used from MD's install folder have the Standard/System Profile flag set
   OK: all SSP profiles have unique names
   OK: all user profiles have unique names
   OK: all profiles have unique URIs
   OK: all packages have unique URIs
   OK: project usage mount relationships are acyclic
   OK: project usage mount relationships are consistent
   OK: all projects are used consistently
   OK: project usage mount relationships are valid
   OK: all shared package usage constraints are consistent
   OK: all modules & project have consistent shared package classifications

Check that the MD Message Window shows something like this:

[2016.01.21::17:42:34] = Project: file:.../samples/ProjectUsageIntegrityChecker/Supplier-Client-Example.mdzip ==========================================
[2016.01.21::17:42:34] =========================================

Check that there is no MD validation window titled: "SSCAE ProjectUsage Validation Results"

Name		Name	Last commit message	Last commit date
Latest commit History 214 Commits
.settings		.settings
doc		doc
icons		icons
launchers		launchers
lib		lib
profiles		profiles
project		project
resources/gov/nasa/jpl/magicdraw/projectUsageIntegrity/options/resources		resources/gov/nasa/jpl/magicdraw/projectUsageIntegrity/options/resources
samples/ProjectUsageIntegrityChecker		samples/ProjectUsageIntegrityChecker
scripts		scripts
src		src
testResources		testResources
.classpath		.classpath
.gitignore		.gitignore
.mailmap		.mailmap
.project		.project
.travis.yml		.travis.yml
MDTeamworkProjectIDSuffixes.txt		MDTeamworkProjectIDSuffixes.txt
README.md		README.md
build.sbt		build.sbt
credentials.sbt.enc		credentials.sbt.enc
deploy_key.enc		deploy_key.enc
gov.nasa.jpl.magicdraw.projectUsageIntegrity.iml		gov.nasa.jpl.magicdraw.projectUsageIntegrity.iml
licenses.sbt		licenses.sbt
log.sbt		log.sbt
project.sbt		project.sbt
publish.sbt		publish.sbt
pubring.gpg.enc		pubring.gpg.enc
runOpenAuditTests.README.txt		runOpenAuditTests.README.txt
runOpenAuditTests.ant		runOpenAuditTests.ant
runTests.ant		runTests.ant
runTests.sh		runTests.sh
secring.gpg.enc		secring.gpg.enc
site.sbt		site.sbt

JPL-IMCE/gov.nasa.jpl.magicdraw.projectUsageIntegrityChecker

Folders and files

Latest commit

History

Repository files navigation

Project Usage Integrity Checker for MagicDraw 18

Documentation

Build Process

Build Artifacts

Test plan

1 PUIC Installable Resource or PUIC Package Bundle

1.1 PUIC Installable Resource

1.2 PUIC Package Bundle

2 PUIC Tests

2.1 Test that PUIC is installed properly

2.2 Test that PUIC profile is not mounted by default

2.3 Test that PUIC properly detects errors

2.4 Test that PUIC properly detects valid propjects

About

Resources

Stars

Watchers

Forks

Languages