Add DeadlineMatcher with tests

DeadlineMatcher is a Matcher interface implementation for handling
pending requests timeouts caused by expiration of Deadline times.

It tries to set Timeout on all reported requests. Some of the timeouts
might be invalid, because the request has change it's state
to canceled or running; or the Deadline time itself has been changed.

Tests base on using MockRequestsManager for mocking up RequestsManager
interface.

Change-Id: I4d790b58a26aa7389250ff57b6bfad662d4d3f7b
Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>

2 files changed, 119 insertions, 0 deletions

diff --git a/matcher/deadlinematcher.go b/matcher/deadlinematcher.go
new file mode 100644
index 0000000..1366127
--- /dev/null
+++ b/matcher/deadlinematcher.go
@@ -0,0 +1,54 @@
+/*
+ *  Copyright (c) 2017-2018 Samsung Electronics Co., Ltd 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
+ */
+
+// File matcher/deadlinematcher.go provides DeadlineMatcher structure.
+// It implements Matcher interface and it should be used for handling timeout
+// events caused by expiration of Deadline requests' times.
+
+package matcher
+
+import (
+	. "git.tizen.org/tools/boruta"
+)
+
+// DeadlineMatcher implements Matcher interface for handling pending requests
+// timeout.
+type DeadlineMatcher struct {
+	Matcher
+	// requests provides internal boruta access to requests.
+	requests RequestsManager
+}
+
+// NewDeadlineMatcher creates a new DeadlineMatcher structure.
+func NewDeadlineMatcher(r RequestsManager) *DeadlineMatcher {
+	return &DeadlineMatcher{
+		requests: r,
+	}
+}
+
+// Notify implements Matcher interface. This method reacts on events passed to
+// matcher. Timeout method is called on RequestsManager for each request.
+// Some of the timeouts might be invalid, because the request's state has been
+// changed to CANCEL or INPROGRESS; or the Deadline time itself has been changed.
+// Verification if timeout conditions are met is done in Timeout() method.
+// If changing state to TIMEOUT is not possible Timeout returns an error.
+// Any errors are ignored as they are false negatives cases from DeadlineMatcher
+// point of view.
+func (m DeadlineMatcher) Notify(dead []ReqID) {
+	for _, r := range dead {
+		m.requests.Timeout(r)
+	}
+}
diff --git a/matcher/deadlinematcher_test.go b/matcher/deadlinematcher_test.go
new file mode 100644
index 0000000..0311a50
--- /dev/null
+++ b/matcher/deadlinematcher_test.go
@@ -0,0 +1,65 @@
+/*
+ *  Copyright (c) 2017-2018 Samsung Electronics Co., Ltd 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 matcher
+
+import (
+	. "git.tizen.org/tools/boruta"
+
+	gomock "github.com/golang/mock/gomock"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("DeadlineMatcher", func() {
+	var ctrl *gomock.Controller
+	var r *MockRequestsManager
+	var m Matcher
+
+	BeforeEach(func() {
+		ctrl = gomock.NewController(GinkgoT())
+		r = NewMockRequestsManager(ctrl)
+		m = NewDeadlineMatcher(r)
+	})
+	AfterEach(func() {
+		ctrl.Finish()
+	})
+	Describe("NewDeadlineMatcher", func() {
+		It("should not use requests", func() {
+			Expect(m).NotTo(BeNil())
+		})
+	})
+	Describe("Notify", func() {
+		It("should run no methods on empty requests", func() {
+			reqs := make([]ReqID, 0)
+
+			m.Notify(reqs)
+		})
+		It("should run Timeout for each reqID passed to Notify and ignore returned errors", func() {
+			err := NotFoundError("Request")
+			reqs := []ReqID{1, 2, 5, 7}
+
+			gomock.InOrder(
+				r.EXPECT().Timeout(reqs[0]).Return(err),
+				r.EXPECT().Timeout(reqs[1]).Return(nil),
+				r.EXPECT().Timeout(reqs[2]).Return(nil),
+				r.EXPECT().Timeout(reqs[3]).Return(err),
+			)
+
+			m.Notify(reqs)
+		})
+	})
+})