Merge pull request #367 from checkr/zz/add-exclude-snapshots-to-expor…

…t-sqlite

Add exclude_snapshots query param to export/sqlite

docs/api_docs/bundle.yaml

@@ -771,6 +771,13 @@ paths:
       tags:
         - export
       operationId: getExportSqlite
+      parameters:
+        - in: query
+          name: exclude_snapshots
+          type: boolean
+          description: >
+            export without snapshots data - useful for smaller db without
+            snapshots
       description: >-
         Export sqlite3 format of the db dump, which is converted from the main
         database.

go.mod

@@ -1,6 +1,6 @@
 module github.com/checkr/flagr
 
-go 1.12
+go 1.14
 
 require (
 	cloud.google.com/go v0.37.4

pkg/handler/export.go

@@ -15,16 +15,16 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-var exportSQLiteHandler = func(export.GetExportSqliteParams) middleware.Responder {
-	f, done, err := exportSQLiteFile()
+var exportSQLiteHandler = func(p export.GetExportSqliteParams) middleware.Responder {
+	f, done, err := exportSQLiteFile(p.ExcludeSnapshots)
 	defer done()
 	if err != nil {
 		return export.NewGetExportSqliteDefault(500).WithPayload(ErrorMessage("%s", err))
 	}
 	return export.NewGetExportSqliteOK().WithPayload(f)
 }
 
-var exportSQLiteFile = func() (file io.ReadCloser, done func(), err error) {
+var exportSQLiteFile = func(excludeSnapshots *bool) (file io.ReadCloser, done func(), err error) {
 	fname := fmt.Sprintf("/tmp/flagr_%d.sqlite", rand.Int31())
 	done = func() {
 		os.Remove(fname)
@@ -37,8 +37,10 @@ var exportSQLiteFile = func() (file io.ReadCloser, done func(), err error) {
 	if err := exportFlags(tmpDB); err != nil {
 		return nil, done, err
 	}
-	if err := exportFlagSnapshots(tmpDB); err != nil {
-		return nil, done, err
+	if excludeSnapshots == nil || !*excludeSnapshots {
+		if err := exportFlagSnapshots(tmpDB); err != nil {
+			return nil, done, err
+		}
 	}
 	if err := exportFlagEntityTypes(tmpDB); err != nil {
 		return nil, done, err

pkg/handler/export_test.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/checkr/flagr/pkg/entity"
+	"github.com/checkr/flagr/pkg/util"
 	"github.com/checkr/flagr/swagger_gen/restapi/operations/export"
 	"github.com/prashantv/gostub"
 	"github.com/stretchr/testify/assert"
@@ -63,8 +64,16 @@ func TestExportSQLiteFile(t *testing.T) {
 	defer db.Close()
 	defer gostub.StubFunc(&getDB, db).Reset()
 
-	t.Run("happy code path", func(t *testing.T) {
-		f, done, err := exportSQLiteFile()
+	t.Run("happy code path and export everything in db", func(t *testing.T) {
+		f, done, err := exportSQLiteFile(nil)
+		defer done()
+
+		assert.NoError(t, err)
+		assert.NotNil(t, f)
+	})
+
+	t.Run("happy code path and exclude_snapshots", func(t *testing.T) {
+		f, done, err := exportSQLiteFile(util.BoolPtr(true))
 		defer done()
 
 		assert.NoError(t, err)

swagger/export_sqlite.yaml

@@ -2,6 +2,12 @@ get:
   tags:
     - export
   operationId: getExportSqlite
+  parameters:
+    - in: query
+      name: exclude_snapshots
+      type: boolean
+      description: >
+        export without snapshots data - useful for smaller db without snapshots
   description: Export sqlite3 format of the db dump, which is converted from the main database.
   produces:
     - application/octet-stream