Skip to content

Commit

Permalink
consumed
Browse files Browse the repository at this point in the history
  • Loading branch information
@milesstoetzner
milesstoetzner authored Nov 17, 2023
1 parent aa28b44 commit 7e1c290
Show file tree
Hide file tree
Showing 78 changed files with 355 additions and 190 deletions.
63 changes: 33 additions & 30 deletions docs/docs/variability4tosca/specification/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,23 +188,23 @@ The following options are used to configure the pruning of elements.

The following options are used to configure checks.

| Keyname | Mandatory | Type | Default | Description |
|----------------------------------------------|-----------|-----------|---------|---------------------------------------------------------------------------------|
| checks | false | Boolean | true | Enable all checks. |
| consistency_checks | false | Boolean | true | Enable all consistency checks. |
| semantic_checks | false | Boolean | true | Enable all semantic checks. |
| relation_source_consistency_check | false | Boolean | true | Enable the consistency check regarding present relation sources. |
| relation_target_consistency_check | false | Boolean | true | Enable the consistency check regarding present relation targets. |
| ambiguous_hosting_consistency_check | false | Boolean | true | Enable the consistency check regarding at maximum one present hosting relation. |
| missing_artifact_container_consistency_check | false | Boolean | true | Enable the consistency check regarding present container of artifacts. |
| ambiguous_artifact_consistency_check | false | Boolean | true | Enable the consistency check regarding ambiguous present artifacts. |
| missing_property_container_consistency_check | false | Boolean | true | Enable the consistency check regarding present container of properties. |
| ambiguous_property_consistency_check | false | Boolean | true | Enable the consistency check regarding ambiguous present properties. |
| missing_type_container_consistency_check | false | Boolean | true | Enable the consistency check regarding present containers of types. |
| ambiguous_type_consistency_check | false | Boolean | ture | Enable the consistency check regarding exactly one present type per container. |
| expected_hosting_semantic_check | false | Boolean | true | Enable the semantic check regarding an expected present hosting relation. |
| expected_incoming_relation_semantic_check | false | Boolean | true | Enable the semantic check regarding an expected incoming relation. |
| expected_artifact_semantic_check | false | Boolean | true | Enable the semantic check regarding an expected artifact. |
| Keyname | Mandatory | Type | Default | Description |
|----------------------------------|-----------|-----------|---------|---------------------------------------------------------------------------------|
| checks | false | Boolean | true | Enable all checks. |
| consistency_checks | false | Boolean | true | Enable all consistency checks. |
| semantic_checks | false | Boolean | true | Enable all semantic checks. |
| relation_source_check | false | Boolean | true | Enable the consistency check regarding present relation sources. |
| relation_target_check | false | Boolean | true | Enable the consistency check regarding present relation targets. |
| ambiguous_hosting_check | false | Boolean | true | Enable the consistency check regarding at maximum one present hosting relation. |
| missing_artifact_container_check | false | Boolean | true | Enable the consistency check regarding present container of artifacts. |
| ambiguous_artifact_check | false | Boolean | true | Enable the consistency check regarding ambiguous present artifacts. |
| missing_property_container_check | false | Boolean | true | Enable the consistency check regarding present container of properties. |
| ambiguous_property_check | false | Boolean | true | Enable the consistency check regarding ambiguous present properties. |
| missing_type_container_check | false | Boolean | true | Enable the consistency check regarding present containers of types. |
| ambiguous_type_check | false | Boolean | ture | Enable the consistency check regarding exactly one present type per container. |
| expected_hosting_check | false | Boolean | true | Enable the semantic check regarding an expected present hosting relation. |
| expected_incoming_relation_check | false | Boolean | true | Enable the semantic check regarding an expected incoming relation. |
| expected_artifact_check | false | Boolean | true | Enable the semantic check regarding an expected artifact. |

### Solver Options

Expand All @@ -220,6 +220,8 @@ The following options are used to configure the solver.

### Constraints Options

_This is an experimental feature._

The following options are used to configure constraints.

| Keyname | Mandatory | Type | Default | Description |
Expand Down Expand Up @@ -393,20 +395,21 @@ A node template is a conditional element, thus, variability conditions and other
These conditions must hold otherwise the respective node template is not present.
A node template can also hold conditional types, artifact, and properties.

| Keyname | Mandatory | Type | Description |
|-------------------------------|-----------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | true | String | List(Map(String, TypeAssignment)) | The type or a list of conditional type assignments. |
| conditions | false | VariabilityCondition | List(VariabilityCondition) | An optional variability condition. If a list is given, then the conditions are combined using the _and_ operation. |
| artifacts | false | Map(String, Artifact) | List(Map(String, Artifact){single}) | An optional map of artifact or a list of artifact maps. If a list is given, then each artifact map must contain only one artifact. |
| properties | false | Map(String, PropertyAssignment) | List(Map(String, PropertyAssignment){single}) | An optional map of property assignments or a list of property assignments maps. If a list is given, then each property assignment map must contain only one property. |
| default_condition | false | Boolean | Enable the default condition for this element. This overrides the variability options of the variable topology template. |
| Keyname | Mandatory | Type | Description |
|-------------------------------|-----------|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | true | String | List(Map(String, TypeAssignment)) | The type or a list of conditional type assignments. |
| conditions | false | VariabilityCondition | List(VariabilityCondition) | An optional variability condition. If a list is given, then the conditions are combined using the _and_ operation. |
| artifacts | false | Map(String, Artifact) | List(Map(String, Artifact){single}) | An optional map of artifact or a list of artifact maps. If a list is given, then each artifact map must contain only one artifact. |
| properties | false | Map(String, PropertyAssignment) | List(Map(String, PropertyAssignment){single}) | An optional map of property assignments or a list of property assignments maps. If a list is given, then each property assignment map must contain only one property. |
| default_condition | false | Boolean | Enable the default condition for this element. This overrides the variability options of the variable topology template. |
| default_consistency_condition | false | Boolean | Enable the default consistency condition for this element. Default condition must be enabled for this element. This overrides the variability options of the variable topology template. |
| default_semantic_condition | false | Boolean | Enable the default semantic condition for this element. Default condition must be enabled for this element. This overrides the variability options of the variable topology template. |
| default_condition_mode | false | source | relation | host | source-host | relation-host | Configure the default condition for this element. |
| pruning | false | Boolean | Enable the pruning for this element. This overrides the variability options of the variable topology template. |
| consistency_pruning | false | Boolean | Enable the consistency pruning for this element. Pruning must be enabled for this element. This overrides the variability options of the variable topology template. |
| semantic_pruning | false | Boolean | Enable the semantic pruning for this element. Pruning must be enabled for this element. This overrides the variability options of the variable topology template. |
| weight | false | Boolean | Non-Negative Number | Configure the weight of this element used during optimization (default is 1). _This is an experimental feature._ |
| default_semantic_condition | false | Boolean | Enable the default semantic condition for this element. Default condition must be enabled for this element. This overrides the variability options of the variable topology template. |
| default_condition_mode | false | source | relation | host | source-host | relation-host | Configure the default condition for this element. |
| consumed | false | Boolean | Configure if node is consumed, e.g., by an end user from the browser. This will prevent unexpected pruning by setting the pruning option to false. |
| pruning | false | Boolean | Enable the pruning for this element. This overrides the variability options of the variable topology template. |
| consistency_pruning | false | Boolean | Enable the consistency pruning for this element. Pruning must be enabled for this element. This overrides the variability options of the variable topology template. |
| semantic_pruning | false | Boolean | Enable the semantic pruning for this element. Pruning must be enabled for this element. This overrides the variability options of the variable topology template. |
| weight | false | Boolean | Non-Negative Number | Configure the weight of this element used during optimization (default is 1). _This is an experimental feature._ |

For example, the following node template has a variability condition assigned.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-artifacts-conditional.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ topology_template:
variability:
options:
type_default_condition: true
expected_artifact_semantic_check: false
expected_artifact_check: false
node_templates:
node_one:
type: node
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-artifacts-default-alternative-false.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tosca_definitions_version: tosca_variability_1_0
topology_template:
variability:
options:
expected_artifact_semantic_check: false
expected_artifact_check: false
node_templates:
node_one:
type: node
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-artifacts-default-alternative.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tosca_definitions_version: tosca_variability_1_0
topology_template:
variability:
options:
expected_artifact_semantic_check: false
expected_artifact_check: false
node_templates:
node_one:
type: node
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-circles-delta.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ topology_template:
node_default_condition: true
relation_default_condition: true
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
node_one:
type: node_one
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-groups-conditional.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ topology_template:
variability:
options:
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
groups:
group_one:
type: variability.groups.ConditionalMembers
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-groups-default-condition-nothing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ topology_template:
variability:
options:
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
groups:
group_one:
type: variability.groups.ConditionalMembers
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-groups-default-condition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topology_template:
options:
group_default_condition: true
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
groups:
group_one:
type: variability.groups.ConditionalMembers
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-groups-prune.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topology_template:
options:
group_pruning: true
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
groups:
group_one:
type: variability.groups.ConditionalMembers
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-nodes-conditional.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ topology_template:
variability:
options:
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
one:
type: one
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-nodes-default-false-false.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ topology_template:
node_default_condition: false
relation_pruning: true
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
node_one:
type: node_one
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-nodes-default-true-false.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ topology_template:
node_default_condition: true
relation_pruning: true
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
node_one:
type: node_one
Expand Down
2 changes: 1 addition & 1 deletion ...s/variability4tosca/tests/test-properties-artifact-container-presence-absent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tosca_definitions_version: tosca_variability_1_0
topology_template:
variability:
options:
expected_artifact_semantic_check: false
expected_artifact_check: false
node_templates:
container:
type: container
Expand Down
2 changes: 1 addition & 1 deletion ...s/variability4tosca/tests/test-properties-relation-container-presence-absent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ topology_template:
variability:
options:
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
container:
type: container
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-pruning-foxtrott-default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ topology_template:
relation_default_condition: true
relation_default_condition_mode: source-target
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
source:
type: source
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-pruning-lima-default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ topology_template:
relation_default_condition: true
relation_default_condition_mode: source-target
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
source:
type: source
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-pruning-outgoing-relation-absent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ topology_template:
relation_default_condition: true
relation_default_condition_mode: source-target
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
source:
type: source
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/variability4tosca/tests/test-pruning-outgoingnaive-target-present.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ topology_template:
relation_default_condition: true
relation_default_condition_mode: source-target
type_default_condition: true
expected_incoming_relation_semantic_check: false
expected_incoming_relation_check: false
node_templates:
source:
type: source
Expand Down
Loading

0 comments on commit 7e1c290

Please sign in to comment.