Merge pull request #126 from triggermesh/task/replace-frequency-with-interval

HTTP Poller: replace frequency with interval

Author: Pablo Mercado

config/300-httppollersource.yaml

@@ -92,8 +92,8 @@ spec:
                 type: object
                 additionalProperties:
                   type: string
-              frequency:
-                description: Polling frequency duration.
+              interval:
+                description: Polling interval.
                 type: string
               sink:
                 description: Reference to an event sink.
@@ -143,7 +143,7 @@ spec:
             - eventType
             - method
             - endpoint
-            - frequency
+            - interval
             - sink
           status:
             description: Status of the event source.

config/samples/httppollersource.yaml

@@ -23,7 +23,7 @@ spec:
   eventSource: gov.weather
   endpoint: https://api.weather.gov/alerts/active?area=KS
   method: GET
-  frequency: 20s
+  interval: 20s
   sink:
     ref:
       apiVersion: serving.knative.dev/v1

pkg/adapter/httppollersource/adapter.go

@@ -67,7 +67,7 @@ func NewAdapter(ctx context.Context, aEnv adapter.EnvConfigAccessor, ceClient cl
 	return &httpPoller{
 		eventType:   env.EventType,
 		eventSource: env.EventSource,
-		frequency:   env.Frequency,
+		interval:    env.Interval,
 
 		httpClient:  httpClient,
 		httpRequest: httpRequest,

pkg/adapter/httppollersource/env.go

@@ -39,5 +39,5 @@ type envAccessor struct {
 	BasicAuthUsername string            `envconfig:"HTTPPOLLER_BASICAUTH_USERNAME"`
 	BasicAuthPassword string            `envconfig:"HTTPPOLLER_BASICAUTH_PASSWORD"`
 	Headers           map[string]string `envconfig:"HTTPPOLLER_HEADERS"`
-	Frequency         time.Duration     `envconfig:"HTTPPOLLER_FREQUENCY" required:"true"`
+	Interval          time.Duration     `envconfig:"HTTPPOLLER_INTERVAL" required:"true"`
 }

pkg/adapter/httppollersource/httppoller.go

@@ -33,7 +33,7 @@ import (
 type httpPoller struct {
 	eventType   string
 	eventSource string
-	frequency   time.Duration
+	interval    time.Duration
 
 	ceClient cloudevents.Client
 
@@ -54,7 +54,7 @@ func (h *httpPoller) Start(ctx context.Context) error {
 	// setup context for the request object.
 	h.httpRequest = h.httpRequest.Clone(ctx)
 
-	t := time.NewTicker(h.frequency)
+	t := time.NewTicker(h.interval)
 
 	for {
 		select {

pkg/adapter/httppollersource/httppoller_test.go

@@ -151,7 +151,7 @@ func TestHTTPPollerRequests(t *testing.T) {
 			p := httpPoller{
 				eventType:   tEventType,
 				eventSource: tEventSource,
-				frequency:   5 * time.Second,
+				interval:    5 * time.Second,
 
 				ceClient:    ceClient,
 				httpRequest: httpRequest,

pkg/apis/sources/v1alpha1/httppollersource_types.go

@@ -83,12 +83,12 @@ type HTTPPollerSourceSpec struct {
 	// +optional
 	BasicAuthPassword *ValueFromField `json:"basicAuthPassword,omitempty"`
 
-	// Headers to be included at HTTP requests
+	// Headers to be included at HTTP requests.
 	// +optional
 	Headers map[string]string `json:"headers,omitempty"`
 
-	// Frequency polling the endpoint
-	Frequency tmapis.Duration `json:"frequency"`
+	// Interval between polling requests.
+	Interval tmapis.Duration `json:"interval"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

pkg/reconciler/httppollersource/adapter.go

@@ -44,7 +44,7 @@ const (
 	envHTTPPollerBasicAuthUsername = "HTTPPOLLER_BASICAUTH_USERNAME"
 	envHTTPPollerBasicAuthPassword = "HTTPPOLLER_BASICAUTH_PASSWORD"
 	envHTTPPollerHeaders           = "HTTPPOLLER_HEADERS"
-	envHTTPPollerFrequency         = "HTTPPOLLER_FREQUENCY"
+	envHTTPPollerInterval          = "HTTPPOLLER_INTERVAL"
 )
 
 // adapterConfig contains properties used to configure the source's adapter.
@@ -106,8 +106,8 @@ func makeHTTPPollerEnvs(src *v1alpha1.HTTPPollerSource) []corev1.EnvVar {
 		Name:  envHTTPPollerSkipVerify,
 		Value: strconv.FormatBool(skipVerify),
 	}, {
-		Name:  envHTTPPollerFrequency,
-		Value: src.Spec.Frequency.String(),
+		Name:  envHTTPPollerInterval,
+		Value: src.Spec.Interval.String(),
 	}}
 
 	if src.Spec.Headers != nil {

pkg/reconciler/httppollersource/reconciler_test.go

@@ -80,7 +80,7 @@ func newEventSource() *v1alpha1.HTTPPollerSource {
 			EventType:  "test-type",
 			Endpoint:   *endpoint,
 			Method:     "GET",
-			Frequency:  tmapis.Duration(time.Second * 5),
+			Interval:   tmapis.Duration(time.Second * 5),
 			SkipVerify: &skipVerify,
 			Headers: map[string]string{
 				"h1": "v1",