implemented retention and api

Author: flaviostutz

Dockerfile

@@ -25,7 +25,6 @@ ENV WEBHOOK_DELETE_BODY     ''
 ENV WEBHOOK_GRACE_TIME      3600
 ENV DATA_DIR                '/var/lib/schelly/data'
 
-ENV RETENTION_SECONDLY    0@L
 ENV RETENTION_MINUTELY    0@L
 ENV RETENTION_HOURLY      0@L
 ENV RETENTION_DAILY       4@L

README.md

@@ -3,7 +3,7 @@ Schelly is a backup tool focused on the scheduling stuff, so that the heavy lift
 
 The triggering and retainment of backups are based on the functional perception of backups, so you configure:
    - Triggering cron string: cron string that defines when a new backup will be created (by calling a backend backup webhook, as [schelly-restic](http://github.com/flaviostutz/schelly-restic), for example)
-   - Retention policies: for how long do a backup must be retained? It depends on what the user needs when something goes wrong. In general, the more recent, more backups in time you need. By default, Schelly will try to keep something like (if a backup is outsIDe this, the webhook for backup removal will be called):
+   - Retention policies: for how long do a backup must be retained? It depends on what the user needs when something goes wrong. In general, the more recent, more backups in time you need. By default, Schelly will try to keep something like (if a backup is outside this, the webhook for backup removal will be called):
        - the last 4 daily backups
        - the last 4 weekly backps
        - the last 3 monthly backups
@@ -26,10 +26,60 @@ The triggering and retainment of backups are based on the functional perception
 * RETENTION_YEARLY - retention config for years
 format "header1=contents1,header2=contents2"
 * WEBHOOK_BODY - custom data to be sent as body for webhook calls to backup backends
-* GRACE\_TIME\_SECONDS - when trying to run a new backup task, if a previous task is still running because it dIDn't finish yet, check for this parameter. if time elapsed for the running task is greater than this parameter, try to cancel it by emitting a DELETE webhook and start the new task, else mark the new task as SKIPPED and keep the running task as is.
+* GRACE\_TIME\_SECONDS - when trying to run a new backup task, if a previous task is still running because it didn't finish yet, check for this parameter. if time elapsed for the running task is greater than this parameter, try to cancel it by emitting a DELETE webhook and start the new task, else mark the new task as SKIPPED and keep the running task as is.
+
+# REST API
+
+  - ```GET /backups```
+    - Query backups managed by Schelly
+    - Request body: none
+    - Request header: none
+    - Response body: json 
+     
+      ```
+        {
+           id:{same id as returned by underlying webhook on backup creation},
+           status:{backup-status}
+           start_time:{time of backup trigger on webhook}
+           end_time:{time of backup finish detection}
+           custom_data:{data returned from webhook}
+           tags: {array of tags}
+        }
+      ```
+      - status must be one of:
+          - 'running' - backup is not finished yet
+          - 'available' - backup has completed successfuly
+      
+      - tags may be: 'minutely', 'hourly', 'daily', 'weekly', 'monthly', 'yearly'
+      
+    - Status code 201 if created successfuly
+
+  - ```POST /backups```
+    - Trigger a new backup now
+    - Request body: none
+    - Request header: none
+    - Response body: json 
+     
+      ```
+        {
+           id:{same id as returned by underlying webhook on backup creation},
+           status:{backup-status}
+           start_time:{time of backup trigger on webhook}
+           end_time:{time of backup finish detection}
+           custom_data:{data returned from webhook}
+        }
+      ```
+      - status must be one of:
+          - 'running' - backup is not finished yet
+          - 'available' - backup has completed successfuly
+            
+    - Status code 201 if created successfuly
+
 
 # Webhook spec
 
+will be invoked when Schelly needs to create/delete a backup on a backend server
+
 The webhook server must expose the following REST endpoints:
 
   - ```POST {webhook-url}```
@@ -40,7 +90,7 @@ The webhook server must expose the following REST endpoints:
      
       ```
         {
-           ID:{alphanumeric-backup-ID},
+           id:{alphanumeric-backup-id},
            status:{backup-status}
            message:{backend-message}
         }
@@ -51,29 +101,29 @@ The webhook server must expose the following REST endpoints:
       
     - Status code 201 if created successfuly
 
-  - ```GET {webhook-url}/{backup-ID}```
+  - ```GET {webhook-url}/{backup-id}```
     - Invoked when Schelly wants to query a specific backup instance
     - Request header: ```{webhook-headers}```
     - Response body: json
     
        ```
          {
-           ID:{ID},
+           id:{id},
            status:{backup-status},
            message:{backend message}
          }
        ```
     - Status code: 200 if found, 404 if not found
 
-  - ```DELETE {webhook-url}/{backup-ID}```
+  - ```DELETE {webhook-url}/{backup-id}```
     - Invoked when Schelly wants to trigger a new backup
     - Request body: json ```{webhook-delete-body}```
     - Request header: ```{webhook-headers}```
     - Response body: json 
      
       ```
         {
-           ID:{alphanumeric-backup-ID},
+           id:{alphanumeric-backup-id},
            status:{backup-status}
            message:{backend-message}
         }

docker-compose.yml

@@ -5,7 +5,9 @@ services:
   schelly:
     build:
       context: .
-      # target: IMAGE
+      target: IMAGE
+    ports:
+      - 7070:8080
     environment:
       - LOG_LEVEL=debug
       - BACKUP_NAME=test
@@ -14,9 +16,8 @@ services:
       - WEBHOOK_HEADERS=k1=v1,k2=v2
       # - WEBHOOK_CREATE_BODY=""
       # - WEBHOOK_DELETE_BODY=""
-      # - WEBHOOK_GRACE_TIME=""
-      # - RETENTION_SECONDLY=""
-      # - RETENTION_MINUTELY=""
+      - WEBHOOK_GRACE_TIME=30
+      - RETENTION_MINUTELY=2
       # - RETENTION_HOURLY=""
       # - RETENTION_DAILY=""
       # - RETENTION_WEEKLY=""

main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	_ "bytes"
+	_ "context"
 	_ "database/sql"
 	_ "encoding/json"
 	_ "flag"
@@ -15,6 +16,7 @@ import (
 	_ "time"
 
 	_ "github.com/Sirupsen/logrus"
+	_ "github.com/gorilla/mux"
 	_ "github.com/mattn/go-sqlite3"
 	_ "github.com/robfig/cron"
 )

schelly/api.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+
+	"github.com/Sirupsen/logrus"
+	"github.com/gorilla/mux"
+)
+
+func startRestAPI() {
+	router := mux.NewRouter()
+	router.HandleFunc("/backups", GetBackups).Methods("GET")
+	router.HandleFunc("/backups", TriggerBackup).Methods("POST")
+	listen := fmt.Sprintf("%s:%d", options.listenIP, options.listenPort)
+	logrus.Infof("Listening at %s", listen)
+	err := http.ListenAndServe(listen, router)
+	if err != nil {
+		logrus.Errorf("Error while listening requests: %s", err)
+		os.Exit(1)
+	}
+}
+
+//GetBackups get currently tracked backups
+func GetBackups(w http.ResponseWriter, r *http.Request) {
+	logrus.Debugf("GetBackups r=%s", r)
+	tag := r.URL.Query().Get("tag")
+	backups, err := getMaterializedBackups(0, tag)
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	rjson := ""
+	for _, b := range backups {
+		tags := ""
+
+		bt := getTags(b)
+		for _, tag := range bt {
+			if tags != "" {
+				tags = tags + ","
+			}
+			tags = tags + "\"" + tag + "\""
+		}
+
+		if rjson != "" {
+			rjson = rjson + ","
+		}
+		rjson = rjson + "{\"id\":\"" + b.ID + "\", \"status\":\"" + b.Status + "\", \"start_time\":\"" + fmt.Sprintf("%s", b.StartTime) + "\", \"end_time\":\"" + fmt.Sprintf("%s", b.EndTime) + "\", \"custom_data\":\"" + b.CustomData + "\", \"tags\":[" + tags + "]}"
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	w.Write([]byte("[" + rjson + "]"))
+	logrus.Debugf("result: %s", "["+rjson+"]")
+}
+
+//TriggerBackup get currently tracked backups
+func TriggerBackup(w http.ResponseWriter, r *http.Request) {
+	logrus.Debugf("TriggerBackup r=%s", r)
+	result, err := triggerNewBackup()
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	w.Header().Set("Content-Type", "application/json")
+	rs := "{}"
+	if result.ID != "" {
+		rs = "{id:'" + result.ID + "',status:'" + result.Status + "',message:'" + result.Message + "'}"
+	}
+	w.Write([]byte(rs))
+	logrus.Debugf("result: %s", rs)
+}