tla-sbuilder 0.1.0

data/src/pet/correctness.cfg

@@ -0,0 +1,9 @@
+INVARIANT ValidatePets
+INVARIANT UniquePet
+INVARIANT UniqueTag
+INVARIANT ValidReferecendTag
+INVARIANT CoherentOwnerAddress
+
+\* Type invariants
+INVARIANT Pets_TypeInvariant
+INVARIANT Tags_TypeInvariant

data/src/pet/correctness_coherent_owner_address.tla

@@ -0,0 +1,6 @@
+(*
+*  Tag owner address coherence: address on all tags with the same ower are equal
+*  
+*)
+
+CoherentOwnerAddress == \A tag \in v_tags: \A tag2 \in v_tags: tag.owner.name = tag2.owner.name => tag.owner.address = tag2.owner.address

data/src/pet/correctness_pet_name.tla

@@ -0,0 +1,4 @@
+
+\* All pets in 'v_pets' should be valid
+ValidatePets ==  \A pet \in v_pets: ValidatePet( pet )
+

data/src/pet/correctness_ref_tag.tla

@@ -0,0 +1,13 @@
+
+(*
+ *  Reference integrity of pet tags
+ *
+ *  For all pets there exists a unique, valid tag entry.
+ *)
+
+ValidReferecendTag ==
+     \A pet \in v_pets: \E tag \in v_tags:
+            tag.tag = pet.tag
+         /\ ValidOwner( tag.owner )
+         /\ \A pet2 \in v_pets: pet2.tag = pet.tag => pet = pet2
+

data/src/pet/correctness_type_invariants.tla

@@ -0,0 +1,12 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+\* Type of all entries in 'v_pets' is 't_Pet'
+Pets_TypeInvariant == \A entry  \in v_pets: entry \in t_Pet
+
+Tags_TypeInvariant == \A entry  \in v_tags: entry \in t_Tag
+
+

data/src/pet/correctness_unique_pet.tla

@@ -0,0 +1,3 @@
+\* pet.id is unique
+
+UniquePet == \A pet1  \in v_pets:  \A pet2 \in v_pets:   pet1.id = pet2.id => pet1 = pet2

data/src/pet/correctness_unique_tag.tla

@@ -0,0 +1,3 @@
+\* tag.tag is unique
+
+UniqueTag == \A tag1  \in v_tags:  Cardinality( GetTagtByIdentity(tag1.tag ) ) = 1 

data/src/pet/docs/Petstore.md

@@ -0,0 +1,117 @@
+# Problem domain
+
+Each pet is assigned a unique tag, which identifies pet owner. Valid
+owner has an address, which may later change. One owner may possess
+several pets.
+
+Pet store application supports creating tag identifiers. Owner
+information may be given, when a tag is created, or it may be updated
+later on a tag.
+
+# Solution domain
+
+## Features
+
+- I can generate new tag for an owner
+- I  can associate owner with an existing tag
+- I can update owner address on a existing tag
+- I can assign an existig tag to a pet
+
+## Data model
+
+### Data types
+
+* Pet
+  * id : String
+  * name : String
+  * tag : String
+
+* Tag
+  * tag : String
+  * owner : Owner
+
+* Owner
+   * name: String
+   * address: Address
+
+* Address
+   * city: String
+   * street: String
+
+### Data base
+
+* pets: Pet
+
+* tags: Tag
+
+
+## Design
+
+### Application services
+
+* /tags(post)
+  * Features
+     * I can generate tags
+     * I can update owner address on tag
+     * I can associate owner with a tag
+ * Design
+     * Create unique 'tag` identifier
+	 * Insert into `tags`
+     * If address given: update address on existing tags
+
+* /tags(put)
+  * Features
+     * I can update owner address on tag
+     * I can associate owner with a tag
+ * Design
+	 * Update `tags`
+     * Update address on existing tags
+
+* /pets(post):
+  * Features
+    * I can associate owner with a pet
+  * Design
+    * Create new entry in `pets`
+    * Generate unique identifier
+
+### Infrastructure services
+
+* /id/pet(get): 
+
+### Correctness
+
+* Unique pet id
+* Unique tag id
+* Reference integrity of pet tags for all pets there exists a
+  unique valid tag entry
+* Owner address coherence: address on all tags with the same ower are equal
+
+
+### Traces
+
+* tag-post (O1,A1):
+  * <TAG: T1,O1,A1>
+
+* tag-pos( T1 )
+    <PET: P1,T1>  <TAG: T1,O1,A1>
+* <P1,T1> <T1,O1,A1>: pos
+* <P2,T2> <T2,O1,A1>
+* <P2,T1> <T2,O1,A2>
+* <P2,T2> <T2,O1,A2>
+
+
+
+
+
+* Post pet1, tag1
+* Post pet2, tag1  ==> ERROR
+
+* Post tag1, owner1, address1
+* Post pet1, tag1
+* Post tag2, owner1, address2
+  --> 
+* Post pet1, tag1
+* Post pet2, tag1  ==> ERROR
+
+
+* Put tag

data/src/pet/extend/extend_assumptions.mustache

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

data/src/pet/extend/extend_implementation.mustache

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

data/src/pet/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/pet/extend/extend_invariant_cfg.mustache

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

data/src/pet/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/pet/extend/extend_operations.mustache

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

data/src/pet/extend/extend_state.mustache

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

data/src/pet/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/{type}(get)", [ id |-> Next_pet_id ] );
+        return;
+   }
+
+}}
+
+
+{{>infrastructure_id_get.tla}}

data/src/pet/infrastructure_id_get.tla

@@ -0,0 +1,24 @@
+
+\* infrastructure service /id/{type}(get)
+
+procedure infrastructure_id_get( id_type ) {
+
+
+infrastructure_id_get_start:
+
+    \* any ids left?
+    if ( Cardinality( v_ids[ id_type ] ) = 0 ) {
+
+        \* response:  404 & Nil
+        InfrastructureServiceReturn(  "/id/{type}(get)",  "status_404", Nil );
+    }
+    else {
+
+    	\* remove generated id from set of free ids
+        v_ids := [  v_ids EXCEPT ![id_type] = @ \ { Next_id( id_type ) } ] ;
+
+	\* response: 200 && generated id
+        InfrastructureServiceReturn( "/id/{type}(get)", "status_200", [ id |-> Next_id( id_type ) ] );
+     };
+    return;
+}

data/src/pet/interface

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

data/src/pet/interface_delete_pet.tla

@@ -0,0 +1,5 @@
+\* this macro expanded in process
+macro delete_pet( input ) {
+
+      call s_delete_pet( input );
+}

data/src/pet/interface_get_pet.tla

@@ -0,0 +1,4 @@
+macro get_pet( input ) {
+
+      call s_get_pet( input );
+}

data/src/pet/interface_post_pet.tla

@@ -0,0 +1,5 @@
+\* this macro expanded in process
+macro post_pet( input ) {
+
+      call s_post_pet( input );
+}

data/src/pet/interface_post_tag.tla

@@ -0,0 +1,5 @@
+
+macro post_tag( input ) {
+
+      call s_post_tag( input );
+}

data/src/pet/interface_put_tag.tla

@@ -0,0 +1,3 @@
+macro put_tag( input ) {
+      call s_put_tag( input );
+}

data/src/pet/operator

@@ -0,0 +1,30 @@
+{{!
+
+      Application operators
+
+      Example:
+
+      \* All pets should have a name
+      ValidatePetData( pet ) == pet.name # Nil
+
+
+}}
+
+
+{{>operator_next_pet_id.tla}}
+{{>operator_valid_pet.tla}}
+{{>operator_get_pet.tla}}
+{{>operator_responses.tla}}
+{{>operator_new_owner.tla}}
+{{>operator_new_pet.tla}}
+{{>operator_new_tag.tla}}
+{{>operator_valid_owner.tla}}
+{{>operator_valid_tag.tla}}
+
+\* Accessing state
+{{>operator_find_tag_by_owner_name.tla}}
+{{>operator_tag_exists.tla}}
+{{>operator_tag_owner_validated.tla}}
+{{>operator_get_tag.tla}}
+{{>operator_tag_referenced.tla}}
+{{>operator_get_pet_by_tag.tla}}

data/src/pet/operator_find_tag_by_owner_name.tla

@@ -0,0 +1 @@
+FindTagsByOwnerName( owner ) == { entry \in v_tags: entry.owner.name = owner.name  }

data/src/pet/operator_get_pet.tla

@@ -0,0 +1,4 @@
+\* Return pet in pestore
+
+PetStore_GetPetById( id ) == { pet \in v_pets: pet.id = id }
+

data/src/pet/operator_get_pet_by_tag.tla

@@ -0,0 +1,4 @@
+\* Return pet in pestore
+
+PetStore_GetPetByTag( tag ) == { pet \in v_pets: pet.tag = tag }
+

data/src/pet/operator_get_tag.tla

@@ -0,0 +1,10 @@
+(*
+
+   Return set of tags from state variable 'v_tags' matching identity'.
+
+   Notice: model invariant guarantees that 'identity' is unique.
+*)
+
+
+GetTagtByIdentity( identity ) == { t \in v_tags: t.tag = identity }
+

data/src/pet/operator_new_owner.tla

@@ -0,0 +1,3 @@
+\* Create new owner 'name' having 'address'
+New_Owner( name, address ) == [ name |-> name, address |-> address ]
+

data/src/pet/operator_new_pet.tla

@@ -0,0 +1,13 @@
+
+\* Create new pet
+
+New_Pet( pet_input, id ) == [ id |-> id, name |-> pet_input.name, tag |-> pet_input.tag ]
+
+(*
+   Copy all other fields from 'pet_input' expect Next_pet_id
+       {
+         CHOOSE p \in t_Pet :
+	        p.id = Next_pet_id
+                /\ \A key \in DOMAIN pet_input.pet: p[key] = pet_input.pet[key]
+       };
+*)

data/src/pet/operator_new_tag.tla

@@ -0,0 +1,3 @@
+\* Create tag with 'id' for 'owner'
+New_Tag( owner, id ) == [ tag |-> id, owner |-> owner ]
+

data/src/pet/operator_next_pet_id.tla

@@ -0,0 +1,3 @@
+\* Choose any id from from the unused ids in 'v_pet_ids'
+\* Next_pet_id == CHOOSE id \in v_pet_ids: TRUE
+Next_id( type ) == CHOOSE id \in v_ids[type]: TRUE