Add counters to outputComputePlan (#74)

* Add existing count to output

* Fix done counter and test all

* Change to TupleCount

Author: thibaultrobert

EXAMPLES.md

@@ -1405,7 +1405,8 @@ peer chaincode invoke -n mycc -c '{"Args":["createComputePlan","{\"tag\":\"a tag
 {
  "aggregatetupleKeys": null,
  "compositeTraintupleKeys": null,
- "computePlanID": "8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb",
+ "computePlanID": "c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4",
+ "doneCount": 0,
  "status": "todo",
  "tag": "a tag is simply a string",
  "testtupleKeys": [
@@ -1414,7 +1415,8 @@ peer chaincode invoke -n mycc -c '{"Args":["createComputePlan","{\"tag\":\"a tag
  "traintupleKeys": [
   "432fcffdf68892f5e4adeeed8bb618beaeaecf709f840671eca724a3e3109369",
   "d23f8cf290b902417ae698d68e2c6835483521d54fcbece31208517759b7c299"
- ]
+ ],
+ "tupleCount": 3
 }
 ```
 #### ------------ Query an ObjectiveLeaderboard ------------
@@ -1488,14 +1490,15 @@ Smart contract: `queryComputePlan`
 ```
 ##### Command peer example:
 ```bash
-peer chaincode invoke -n mycc -c '{"Args":["queryComputePlan","{\"key\":\"8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb\"}"]}' -C myc
+peer chaincode invoke -n mycc -c '{"Args":["queryComputePlan","{\"key\":\"c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4\"}"]}' -C myc
 ```
 ##### Command output:
 ```json
 {
  "aggregatetupleKeys": null,
  "compositeTraintupleKeys": null,
- "computePlanID": "8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb",
+ "computePlanID": "c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4",
+ "doneCount": 0,
  "status": "todo",
  "tag": "a tag is simply a string",
  "testtupleKeys": [
@@ -1504,7 +1507,8 @@ peer chaincode invoke -n mycc -c '{"Args":["queryComputePlan","{\"key\":\"8412c0
  "traintupleKeys": [
   "432fcffdf68892f5e4adeeed8bb618beaeaecf709f840671eca724a3e3109369",
   "d23f8cf290b902417ae698d68e2c6835483521d54fcbece31208517759b7c299"
- ]
+ ],
+ "tupleCount": 3
 }
 ```
 ##### Command peer example:
@@ -1517,7 +1521,8 @@ peer chaincode invoke -n mycc -c '{"Args":["queryComputePlans"]}' -C myc
  {
   "aggregatetupleKeys": null,
   "compositeTraintupleKeys": null,
-  "computePlanID": "8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb",
+  "computePlanID": "c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4",
+  "doneCount": 0,
   "status": "todo",
   "tag": "a tag is simply a string",
   "testtupleKeys": [
@@ -1526,7 +1531,8 @@ peer chaincode invoke -n mycc -c '{"Args":["queryComputePlans"]}' -C myc
   "traintupleKeys": [
    "432fcffdf68892f5e4adeeed8bb618beaeaecf709f840671eca724a3e3109369",
    "d23f8cf290b902417ae698d68e2c6835483521d54fcbece31208517759b7c299"
-  ]
+  ],
+  "tupleCount": 3
  }
 ]
 ```
@@ -1540,14 +1546,15 @@ Smart contract: `cancelComputePlan`
 ```
 ##### Command peer example:
 ```bash
-peer chaincode invoke -n mycc -c '{"Args":["cancelComputePlan","{\"key\":\"8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb\"}"]}' -C myc
+peer chaincode invoke -n mycc -c '{"Args":["cancelComputePlan","{\"key\":\"c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4\"}"]}' -C myc
 ```
 ##### Command output:
 ```json
 {
  "aggregatetupleKeys": null,
  "compositeTraintupleKeys": null,
- "computePlanID": "8412c09c3ce47cc3f2f4b86d3cb96850bda82ca1c177fbd4f5d4919966db12cb",
+ "computePlanID": "c51b1a4fe5a6c5abe5595ed530fbf1a9d822e6f22c57a029102db82ae71b41e4",
+ "doneCount": 0,
  "status": "canceled",
  "tag": "a tag is simply a string",
  "testtupleKeys": [
@@ -1556,6 +1563,7 @@ peer chaincode invoke -n mycc -c '{"Args":["cancelComputePlan","{\"key\":\"8412c
  "traintupleKeys": [
   "432fcffdf68892f5e4adeeed8bb618beaeaecf709f840671eca724a3e3109369",
   "d23f8cf290b902417ae698d68e2c6835483521d54fcbece31208517759b7c299"
- ]
+ ],
+ "tupleCount": 3
 }
 ```

chaincode/compute_plan.go

@@ -292,6 +292,7 @@ func cancelComputePlan(db *LedgerDB, args []string) (resp outputComputePlan, err
 func (cp *ComputePlan) Create(db *LedgerDB) (string, error) {
 	ID := GetRandomHash()
 	cp.AssetType = ComputePlanType
+	cp.TupleCount = 1
 	err := db.Add(ID, cp)
 	if err != nil {
 		return "", err
@@ -330,7 +331,7 @@ func (cp *ComputePlan) CheckNewTupleStatus(tupleStatus string) bool {
 			return true
 		case StatusDone:
 			cp.DoneCount++
-			if cp.DoneCount == cp.TuplesCount {
+			if cp.DoneCount == cp.TupleCount {
 				cp.Status = tupleStatus
 			}
 			return true

chaincode/compute_plan_test.go

@@ -595,3 +595,52 @@ func TestCreateTagedEmptyComputePlan(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, tag, out.Tag)
 }
+
+func TestComputePlanMetrics(t *testing.T) {
+	scc := new(SubstraChaincode)
+	mockStub := NewMockStubWithRegisterNode("substra", scc)
+	registerItem(t, *mockStub, "aggregateAlgo")
+	mockStub.MockTransactionStart("42")
+	db := NewLedgerDB(mockStub)
+
+	out, err := createComputePlanInternal(db, defaultComputePlan)
+	assert.NoError(t, err)
+	checkComputePlanMetrics(t, db, out.ComputePlanID, 0, 3)
+
+	traintupleToDone(t, db, out.TraintupleKeys[0])
+	checkComputePlanMetrics(t, db, out.ComputePlanID, 1, 3)
+
+	traintupleToDone(t, db, out.TraintupleKeys[1])
+	checkComputePlanMetrics(t, db, out.ComputePlanID, 2, 3)
+
+	testtupleToDone(t, db, out.TesttupleKeys[0])
+	checkComputePlanMetrics(t, db, out.ComputePlanID, 3, 3)
+}
+
+func traintupleToDone(t *testing.T, db *LedgerDB, key string) {
+	_, err := logStartTrain(db, assetToArgs(inputHash{Key: key}))
+	assert.NoError(t, err)
+
+	success := inputLogSuccessTrain{}
+	success.Key = key
+	success.fillDefaults()
+	_, err = logSuccessTrain(db, assetToArgs(success))
+	assert.NoError(t, err)
+}
+func testtupleToDone(t *testing.T, db *LedgerDB, key string) {
+	_, err := logStartTest(db, assetToArgs(inputHash{Key: key}))
+	assert.NoError(t, err)
+
+	success := inputLogSuccessTest{}
+	success.Key = key
+	success.createDefault()
+	_, err = logSuccessTest(db, assetToArgs(success))
+	assert.NoError(t, err)
+}
+
+func checkComputePlanMetrics(t *testing.T, db *LedgerDB, cpID string, doneCount, tupleCount int) {
+	out, err := getOutComputePlan(db, cpID)
+	assert.NoError(t, err)
+	assert.Equal(t, doneCount, out.DoneCount)
+	assert.Equal(t, tupleCount, out.TupleCount)
+}

chaincode/ledger.go

@@ -190,7 +190,7 @@ type ComputePlan struct {
 	Tag                     string    `json:"tag"`
 	TesttupleKeys           []string  `json:"testtupleKeys"`
 	TraintupleKeys          []string  `json:"traintupleKeys"`
-	TuplesCount             int       `json:"tuplesCount"`
+	TupleCount              int       `json:"tupleCount"`
 }
 
 // ---------------------------------------------------------------------------------

chaincode/ledger_db.go

@@ -80,7 +80,7 @@ func (db *LedgerDB) Get(key string, object interface{}) error {
 	if !ok {
 		buff, err = db.cc.GetState(key)
 		if err != nil || buff == nil {
-			return errors.NotFound(err)
+			return errors.NotFound(err, "no asset for key %s", key)
 		}
 		db.putTransactionState(key, buff)
 	}

chaincode/output.go

@@ -299,6 +299,8 @@ type outputComputePlan struct {
 	TesttupleKeys           []string `json:"testtupleKeys"`
 	Tag                     string   `json:"tag"`
 	Status                  string   `json:"status"`
+	TupleCount              int      `json:"tupleCount"`
+	DoneCount               int      `json:"doneCount"`
 }
 
 func (out *outputComputePlan) Fill(key string, in ComputePlan) {
@@ -309,6 +311,8 @@ func (out *outputComputePlan) Fill(key string, in ComputePlan) {
 	out.TesttupleKeys = in.TesttupleKeys
 	out.Status = in.Status
 	out.Tag = in.Tag
+	out.TupleCount = in.TupleCount
+	out.DoneCount = in.DoneCount
 }
 
 type outputPermissions struct {

chaincode/testtuple.go

@@ -191,7 +191,7 @@ func (testtuple *Testtuple) AddToComputePlan(db *LedgerDB, testtupleKey string)
 		return err
 	}
 	computePlan.TesttupleKeys = append(computePlan.TesttupleKeys, testtupleKey)
-	computePlan.TuplesCount++
+	computePlan.TupleCount++
 	computePlan.CheckNewTupleStatus(testtuple.Status)
 	err = computePlan.Save(db, testtuple.ComputePlanID)
 	if err != nil {

chaincode/traintuple.go

@@ -149,7 +149,7 @@ func (traintuple *Traintuple) AddToComputePlan(db *LedgerDB, inp inputTraintuple
 		return err
 	}
 	computePlan.TraintupleKeys = append(computePlan.TraintupleKeys, traintupleKey)
-	computePlan.TuplesCount++
+	computePlan.TupleCount++
 	computePlan.CheckNewTupleStatus(traintuple.Status)
 	err = computePlan.Save(db, traintuple.ComputePlanID)
 	if err != nil {

chaincode/traintuple_composite.go

@@ -182,7 +182,7 @@ func (traintuple *CompositeTraintuple) AddToComputePlan(db *LedgerDB, inp inputC
 		return err
 	}
 	computePlan.CompositeTraintupleKeys = append(computePlan.CompositeTraintupleKeys, traintupleKey)
-	computePlan.TuplesCount++
+	computePlan.TupleCount++
 	computePlan.CheckNewTupleStatus(traintuple.Status)
 	err = computePlan.Save(db, traintuple.ComputePlanID)
 	if err != nil {

chaincode/tuple_aggregate.go

@@ -153,7 +153,7 @@ func (tuple *Aggregatetuple) AddToComputePlan(db *LedgerDB, inp inputAggregatetu
 		return err
 	}
 	computePlan.AggregatetupleKeys = append(computePlan.AggregatetupleKeys, traintupleKey)
-	computePlan.TuplesCount++
+	computePlan.TupleCount++
 	computePlan.CheckNewTupleStatus(tuple.Status)
 	err = computePlan.Save(db, tuple.ComputePlanID)
 	if err != nil {