Add generic blackbox rawledger tests

This changeset adds tests which are generally applicable to
rawledger implementations.  It enables these tests for both
ramledger and for fileledger.

You may notice that these tests are substantially similar to
the tests in file ledger and were derived from there,
substituting black box equivalents for the implementation
details of fileledger.

This new suite of tests also caught a bug in the ramledger
implementation which could result in a crash when the
specified block was exactly the block number of the oldest
block in storage.  A fix is included.

Change-Id: I76813c8ba7853d47fa6ffa89b16ffc66b8ddfd5f
Signed-off-by: Jason Yellick <[email protected]>

Author: Jason Yellick

orderer/rawledger/blackbox_test.go

@@ -0,0 +1,207 @@
+/*
+Copyright IBM Corp. 2016 All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+                 http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package rawledger_test
+
+import (
+	"bytes"
+	"testing"
+
+	ab "github.com/hyperledger/fabric/orderer/atomicbroadcast"
+	. "github.com/hyperledger/fabric/orderer/rawledger"
+)
+
+type ledgerTestable interface {
+	Initialize() (ledgerFactory, error)
+	Name() string
+}
+
+type ledgerFactory interface {
+	New() ReadWriter
+	Destroy() error
+	Persistent() bool
+}
+
+var testables []ledgerTestable
+
+func getBlock(number uint64, li ReadWriter) *ab.Block {
+	i, _ := li.Iterator(ab.SeekInfo_SPECIFIED, number)
+	select {
+	case <-i.ReadyChan():
+		block, status := i.Next()
+		if status != ab.Status_SUCCESS {
+			return nil
+		}
+		return block
+	default:
+		return nil
+	}
+}
+
+func allTest(t *testing.T, test func(ledgerFactory, *testing.T)) {
+	for _, lt := range testables {
+
+		t.Log("Running test for", lt.Name())
+
+		func() {
+			lf, err := lt.Initialize()
+			if err != nil {
+				t.Fatalf("Error initializing %s: %s", lt.Name(), err)
+			}
+			test(lf, t)
+			err = lf.Destroy()
+			if err != nil {
+				t.Fatalf("Error destroying %s: %s", lt.Name(), err)
+			}
+		}()
+
+		t.Log("Completed test successfully for", lt.Name())
+	}
+}
+
+func TestInitialization(t *testing.T) {
+	allTest(t, testInitialization)
+}
+
+func testInitialization(lf ledgerFactory, t *testing.T) {
+	li := lf.New()
+	if li.Height() != 1 {
+		t.Fatalf("Block height should be 1")
+	}
+	block := getBlock(0, li)
+	if block == nil {
+		t.Fatalf("Error retrieving genesis block")
+	}
+}
+
+func TestReinitialization(t *testing.T) {
+	allTest(t, testReinitialization)
+}
+
+func testReinitialization(lf ledgerFactory, t *testing.T) {
+	if !lf.Persistent() {
+		t.Log("Skipping test as persistence is not available for this ledger type")
+		return
+	}
+	oli := lf.New()
+	aBlock := oli.Append([]*ab.BroadcastMessage{&ab.BroadcastMessage{Data: []byte("My Data")}}, nil)
+	li := lf.New()
+	if li.Height() != 2 {
+		t.Fatalf("Block height should be 2")
+	}
+	block := getBlock(1, li)
+	if block == nil {
+		t.Fatalf("Error retrieving block 1")
+	}
+	if !bytes.Equal(block.Hash(), aBlock.Hash()) {
+		t.Fatalf("Block hashes did no match")
+	}
+}
+
+func TestAddition(t *testing.T) {
+	allTest(t, testAddition)
+}
+
+func testAddition(lf ledgerFactory, t *testing.T) {
+	li := lf.New()
+	genesis := getBlock(0, li)
+	if genesis == nil {
+		t.Fatalf("Could not retrieve genesis block")
+	}
+	prevHash := genesis.Hash()
+
+	li.Append([]*ab.BroadcastMessage{&ab.BroadcastMessage{Data: []byte("My Data")}}, nil)
+	if li.Height() != 2 {
+		t.Fatalf("Block height should be 2")
+	}
+	block := getBlock(1, li)
+	if block == nil {
+		t.Fatalf("Error retrieving genesis block")
+	}
+	if !bytes.Equal(block.PrevHash, prevHash) {
+		t.Fatalf("Block hashes did no match")
+	}
+}
+
+func TestRetrieval(t *testing.T) {
+	allTest(t, testRetrieval)
+}
+
+func testRetrieval(lf ledgerFactory, t *testing.T) {
+	li := lf.New()
+	li.Append([]*ab.BroadcastMessage{&ab.BroadcastMessage{Data: []byte("My Data")}}, nil)
+	it, num := li.Iterator(ab.SeekInfo_OLDEST, 99)
+	if num != 0 {
+		t.Fatalf("Expected genesis block iterator, but got %d", num)
+	}
+	signal := it.ReadyChan()
+	select {
+	case <-signal:
+	default:
+		t.Fatalf("Should be ready for block read")
+	}
+	block, status := it.Next()
+	if status != ab.Status_SUCCESS {
+		t.Fatalf("Expected to successfully read the genesis block")
+	}
+	if block.Number != 0 {
+		t.Fatalf("Expected to successfully retrieve the genesis block")
+	}
+	signal = it.ReadyChan()
+	select {
+	case <-signal:
+	default:
+		t.Fatalf("Should still be ready for block read")
+	}
+	block, status = it.Next()
+	if status != ab.Status_SUCCESS {
+		t.Fatalf("Expected to successfully read the second block")
+	}
+	if block.Number != 1 {
+		t.Fatalf("Expected to successfully retrieve the second block but got block number %d", block.Number)
+	}
+}
+
+func TestBlockedRetrieval(t *testing.T) {
+	allTest(t, testBlockedRetrieval)
+}
+
+func testBlockedRetrieval(lf ledgerFactory, t *testing.T) {
+	li := lf.New()
+	it, num := li.Iterator(ab.SeekInfo_SPECIFIED, 1)
+	if num != 1 {
+		t.Fatalf("Expected block iterator at 1, but got %d", num)
+	}
+	signal := it.ReadyChan()
+	select {
+	case <-signal:
+		t.Fatalf("Should not be ready for block read")
+	default:
+	}
+	li.Append([]*ab.BroadcastMessage{&ab.BroadcastMessage{Data: []byte("My Data")}}, nil)
+	select {
+	case <-signal:
+	default:
+		t.Fatalf("Should now be ready for block read")
+	}
+	block, status := it.Next()
+	if status != ab.Status_SUCCESS {
+		t.Fatalf("Expected to successfully read the second block")
+	}
+	if block.Number != 1 {
+		t.Fatalf("Expected to successfully retrieve the second block")
+	}
+}

orderer/rawledger/fileledger_test.go

@@ -0,0 +1,62 @@
+/*
+Copyright IBM Corp. 2016 All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+                 http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package rawledger_test
+
+import (
+	"io/ioutil"
+	"os"
+
+	. "github.com/hyperledger/fabric/orderer/rawledger"
+	"github.com/hyperledger/fabric/orderer/rawledger/fileledger"
+)
+
+func init() {
+	testables = append(testables, &fileLedgerTestEnv{})
+}
+
+type fileLedgerFactory struct {
+	location string
+}
+
+type fileLedgerTestEnv struct {
+}
+
+func (env *fileLedgerTestEnv) Initialize() (ledgerFactory, error) {
+	var err error
+	location, err := ioutil.TempDir("", "hyperledger")
+	if err != nil {
+		return nil, err
+	}
+	return &fileLedgerFactory{location: location}, nil
+}
+
+func (env *fileLedgerTestEnv) Name() string {
+	return "fileledger"
+}
+
+func (env *fileLedgerFactory) Destroy() error {
+	err := os.RemoveAll(env.location)
+	return err
+}
+
+func (env *fileLedgerFactory) Persistent() bool {
+	return true
+}
+
+func (env *fileLedgerFactory) New() ReadWriter {
+	return fileledger.New(env.location)
+}

orderer/rawledger/ramledger/ramledger.go

@@ -89,11 +89,22 @@ func (rl *ramLedger) Iterator(startType ab.SeekInfo_StartType, specified uint64)
 		}
 		close(list.signal)
 	case ab.SeekInfo_SPECIFIED:
-		list = rl.oldest
-		if specified < list.block.Number || specified > rl.newest.block.Number+1 {
+		oldest := rl.oldest
+		if specified < oldest.block.Number || specified > rl.newest.block.Number+1 {
 			return &rawledger.NotFoundErrorIterator{}, 0
 		}
 
+		if specified == oldest.block.Number {
+			list = &simpleList{
+				block:  &ab.Block{Number: oldest.block.Number - 1},
+				next:   oldest,
+				signal: make(chan struct{}),
+			}
+			close(list.signal)
+			break
+		}
+
+		list = oldest
 		for {
 			if list.block.Number == specified-1 {
 				break

orderer/rawledger/ramledger_test.go

@@ -0,0 +1,51 @@
+/*
+Copyright IBM Corp. 2016 All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+                 http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package rawledger_test
+
+import (
+	. "github.com/hyperledger/fabric/orderer/rawledger"
+	"github.com/hyperledger/fabric/orderer/rawledger/ramledger"
+)
+
+func init() {
+	testables = append(testables, &ramLedgerTestEnv{})
+}
+
+type ramLedgerFactory struct{}
+
+type ramLedgerTestEnv struct{}
+
+func (env *ramLedgerTestEnv) Initialize() (ledgerFactory, error) {
+	return &ramLedgerFactory{}, nil
+}
+
+func (env *ramLedgerTestEnv) Name() string {
+	return "ramledger"
+}
+
+func (env *ramLedgerFactory) Destroy() error {
+	return nil
+}
+
+func (env *ramLedgerFactory) Persistent() bool {
+	return false
+}
+
+func (env *ramLedgerFactory) New() ReadWriter {
+	historySize := 10
+	return ramledger.New(historySize)
+}