tla-sbuilder 0.1.0

data/src-extend/README

@@ -0,0 +1,2 @@
+Commmand sbuilder.rb extend copies content of these directories to cwd.
+

data/src-extend/extend/extend_assumptions.mustache

@@ -0,0 +1,7 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{>assumption}}

data/src-extend/extend/extend_const.mustache

@@ -0,0 +1,5 @@
+(******************************************************************
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+ ******************************************************************)

data/src-extend/extend/extend_implementation.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+
+{{>infrastructure}}
+{{>service}}

data/src-extend/extend/extend_invariant.mustache

@@ -0,0 +1,11 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+\* Operators for correctness 
+{{>correctness}}
+
+\* Operators for possibilities
+{{>possibility}}

data/src-extend/extend/extend_invariant_cfg.mustache

@@ -0,0 +1,7 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{>correctness.cfg}}

data/src-extend/extend/extend_macros.mustache

@@ -0,0 +1,19 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+(* ******************************************************************
+ Transactions (modify state)
+ * ******************************************************************)
+
+{{>transaction}}
+
+
+(* ******************************************************************
+ Macros implmeneting entries to interface services
+ * ******************************************************************)
+
+{{>interface}}
+

data/src-extend/extend/extend_operations.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+
+{{>operator}}
+

data/src-extend/extend/extend_state.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{>state}}
+
+

data/src-extend/extend_app/assumption

@@ -0,0 +1,20 @@
+{{!
+
+   Assumption predicates (and possibly operators), and ASSUME directive.
+   
+   For example:
+
+   \* True iff 'field' in records in 'set'  have correct 'domain'
+   Assume_DomainOfAField( set, field, domain ) == { p[field] : p \in  set }  = domain
+
+   \* Verify that domain of named field is correct
+   Assume_Pet_Domains == Assume_DomainOfAField( t_Pet, "id", d_pet_id )
+
+   \* Domain verification phase 1
+   ASSUME Assume_Pet_Domains
+
+
+}}
+
+{{!>assumption_generic.tla}}
+{{!>assumption_pet.tla}}

data/src-extend/extend_app/correctness

@@ -0,0 +1,19 @@
+{{!
+
+    Define correctness predicates.
+
+    Correctness predicates may refer operators defined in 'operators'.
+    In order to activate invariant add INVARIANT directive in 'correcness.cfg'
+  
+    For example:
+
+    \* When 'PetStore_ValidatePet' is defined in 'operators'
+   
+    \* All pets in 'v_pets' should be valid
+    PetStore_ValidatePets ==  \A pet \in v_pets: PetStore_ValidatePet( pet )
+
+}}
+
+{{!>correctness_pet_name.tla}}
+{{!>correctness_types.tla}}
+

data/src-extend/extend_app/correctness.cfg

@@ -0,0 +1,9 @@
+{{!
+
+   Activate correcness predicates
+
+   For example:
+
+   INVARIANT PetStore_ValidatePets
+
+}}

data/src-extend/extend_app/infrastructure

@@ -0,0 +1,25 @@
+{{!
+
+   Procedure implmenting services for infrastructure interfaces.
+
+   May use 'operators' defined earlier
+
+   For example:
+
+   procedure generateId() {
+
+      generateId_start:
+
+        \* remove one id from set of valid ids
+        v_pet_ids := v_pet_ids \ { Next_pet_id } ;
+
+
+        \* return generated identifier
+        InfrastructureServiceReturn( "/id/pet(get)", [ id |-> Next_pet_id ] );
+        return;
+   }
+
+}}
+
+
+{{!>infrastructure_generate_id.tla}}

data/src-extend/extend_app/interface

@@ -0,0 +1,11 @@
+{{!
+
+   Macros implmeneting entries to interface services
+   
+}}
+
+
+{{!>interface_post_pet.tla}}
+{{!>interface_get_pet.tla}}
+{{!>interface_delete_pet.tla}}
+

data/src-extend/extend_app/operator

@@ -0,0 +1,18 @@
+{{!
+
+      Application operators
+
+      Example:
+
+      \* All pets should have a name
+      PetStore_ValidatePetData( pet ) == pet.name # Nil
+
+
+}}
+
+
+{{!>operator_next_pet_id.tla}}
+{{!>operator_valid_pet.tla}}
+{{!>operator_get_pet.tla}}
+{{!>operator_responses.tla}}
+{{!>operator_new_pet.tla}}

data/src-extend/extend_app/possibility

@@ -0,0 +1,16 @@
+{{!
+
+    Define operator possibilities.
+
+    To activate the operators add per setup add name of the operator
+    to 'possibilities' arrays
+
+    setups:
+      - setupDirectory: setup1
+        possibilities:
+          - poss1
+          - poss2
+
+
+}}
+

data/src-extend/extend_app/service

@@ -0,0 +1,33 @@
+{{!
+
+   Procedures implmenting interface services.
+
+   Notice: Procedure is not necassarily needed if
+   service is fully implemented in interface entry-macro
+   (see interfaces_entry)
+
+
+   For example:
+
+   procedure delete_pet( delete_pet_input ) {
+
+     delete_pet_start:
+
+         \* transaction
+         delete_pet( delete_pet_input );
+
+        return;
+   }
+
+   
+
+}}
+
+{{!>service_pet_post.tla}}
+{{!>service_pet_get.tla}}
+{{!>service_pet_delete.tla}}
+
+
+
+
+

data/src-extend/extend_app/state

@@ -0,0 +1,16 @@
+{{!
+
+     Application variables and initial value
+
+
+     For example:
+
+     \* pet entiries of type t_Pet, initially empty
+     v_pets = {}; 
+
+
+}}
+
+{{!>state_pet.tla}}
+{{!>state_infra.tla}}
+

data/src-extend/extend_app/transaction

@@ -0,0 +1,22 @@
+{{!
+
+      Place to define macros modifying application state.
+
+      For example:
+
+        macro enter_pet( new_pet ) {
+        
+          v_pets := v_pets \union { new_pet };
+        
+        }
+
+}}
+
+
+{{!>transaction_error.tla}}
+{{!>transaction_enter_pet.tla}}
+{{!>transaction_delete_pet.tla}}
+
+
+
+

data/src/pet/assumption

@@ -0,0 +1,29 @@
+{{!
+
+   Assumption predicates (and possibly operators), and ASSUME directive.
+   
+   For example:
+
+   \* True iff 'field' in records in 'set'  have correct 'domain'
+   Assume_DomainOfAField( set, field, domain ) == { p[field] : p \in  set }  = domain
+
+   \* Verify that domain of named field is correct
+   Assume_Pet_Domains == Assume_DomainOfAField( t_Pet, "id", d_id )
+
+   \* Domain verification phase 1
+   ASSUME Assume_Pet_Domains
+
+
+}}
+
+{{>assumption_generic.tla}}
+
+
+\* Defintion domains 
+{{>assumption_address_domains.tla}}
+{{>assumption_owner_domains.tla}}
+{{>assumption_tag_domains.tla}}
+{{>assumption_pet_domains.tla}}
+{{>assumption_id_domains.tla}}
+{{>assumption_domains.tla}}
+

data/src/pet/assumption_address_domains.tla

@@ -0,0 +1,12 @@
+(*
+     Domains in Address definition
+
+     - street : d_street
+     - city   : d_city
+
+*)
+
+Assume_Address_Domains ==
+                      Assume_CorrectDomain( t_Address, "street", d_street )
+                   /\ Assume_CorrectDomain( t_Address, "city", d_city )		   
+

data/src/pet/assumption_domains.tla

@@ -0,0 +1,16 @@
+(*
+
+    Operator combining assumption on all defintions.
+
+*)
+
+
+Assume_Domains ==
+                Assume_Pet_Domains
+             /\ Assume_Id_Domains
+             /\ Assume_Tag_Domains		
+             /\ Assume_Address_Domains
+	     /\ Assume_Owner_Domains
+
+
+ASSUME Assume_Domains

data/src/pet/assumption_generic.tla

@@ -0,0 +1,8 @@
+(* ******************************************************************
+   Helpers to make assumptions
+   ******************************************************************)
+
+
+\* True iff  in all records in 'set' have 'field' type 'domain'
+Assume_CorrectDomain( set, field, domain ) == { p[field] : p \in  set }  = domain
+

data/src/pet/assumption_id_domains.tla

@@ -0,0 +1,2 @@
+
+Assume_Id_Domains == Assume_CorrectDomain( t_Id, "id", d_id )

data/src/pet/assumption_owner_domains.tla

@@ -0,0 +1,14 @@
+(*
+     Domains in Owner definition
+
+     - name : d_owner_name
+     - address   : t_Address
+
+*)
+
+
+
+Assume_Owner_Domains ==
+                      Assume_CorrectDomain( t_Owner, "name", d_owner_name )
+		   /\ Assume_CorrectDomain( t_Owner, "address", t_Address )
+		      

data/src/pet/assumption_pet_domains.tla

@@ -0,0 +1,16 @@
+(*
+     Domains in Pet definition
+
+     - id    : d_id
+     - name  : d_pet_name
+     - tag   : d_id
+
+*)
+
+
+
+\* Verify that domain of named field is correct
+Assume_Pet_Domains == Assume_CorrectDomain( t_Pet, "id", d_id )
+                   /\ Assume_CorrectDomain( t_Pet, "name", d_pet_name )
+                   /\ Assume_CorrectDomain( t_Pet, "tag", d_id )
+

data/src/pet/assumption_tag_domains.tla

@@ -0,0 +1,13 @@
+(*
+     Domains in Tag definition
+
+     - tag     : d_id
+     - owner   : t_Owner
+
+*)
+
+
+
+Assume_Tag_Domains == Assume_CorrectDomain( t_Tag, "tag", d_id )
+	           /\ Assume_CorrectDomain( t_Tag, "owner", t_Owner )
+

data/src/pet/correctness

@@ -0,0 +1,24 @@
+{{!
+
+    Correctness predicates.
+
+    Correctness predicates may refer operators defined in 'operators'.
+    In order to activate invariant add INVARIANT directive in 'correcness.cfg'
+  
+    For example:
+
+    \* When 'ValidatePet' is defined in 'operators'
+   
+    \* All pets in 'v_pets' should be valid
+    ValidatePets ==  \A pet \in v_pets: ValidatePet( pet )
+
+}}
+
+{{>correctness_type_invariants.tla}}
+
+{{>correctness_pet_name.tla}}
+{{>correctness_unique_pet.tla}}
+{{>correctness_unique_tag.tla}}
+{{>correctness_ref_tag.tla}}
+{{>correctness_coherent_owner_address.tla}}
+