background: added tests for the enabled? methods

I've also added a couple of fixes that were missing from SUSE#1679.

Signed-off-by: Miquel Sabaté Solà <[email protected]>

config/config.yml

@@ -281,10 +281,25 @@ security:
 anonymous_browsing:
   enabled: true
 
-# Environment variables for ensuring the execution of the
-# background tasks 'registry' and 'sync'.
+# Configuration for the background tasks.
 background:
-  registry: 
+  # The registry integration: it processes the given registry events (e.g. a new
+  # tag was pushed). It's therefore highly *discouraged* to disable this task.
+  registry:
     enabled: true
-  sync: 
+
+  # Registry synchronization: it synchronizes all the contents from the registry
+  # into the database.
+  sync:
     enabled: true
+
+    # There are four accepted values:
+    #   - update-delete: it performs a full synchronization.
+    #   - update: it only adds missing tags, but it does not remove any contents
+    #     from the database.
+    #   - on-start: when starting Portus it runs an `update-delete` and then it
+    #     gets disabled (i.e. it will only run once).
+    #   - initial: like `on-start`, but it only runs if the database is
+    #     empty. This is the default value since it's deemed to be the most
+    #     common use-case.
+    sync-strategy: initial

lib/portus/background/registry.rb

@@ -19,9 +19,10 @@ def work?
 
       def enabled?
         val = APP_CONFIG.enabled?("background.registry")
-				Rails.logger.warn("Registry integration has been disabled. This is highly discouraged!") unless val
-				val
-			end
+        msg = "Registry integration has been disabled. This is highly discouraged!"
+        Rails.logger.warn(msg) unless val
+        val
+      end
 
       def execute!
         RegistryEvent.where(status: RegistryEvent.statuses[:fresh]).find_each do |e|

lib/portus/background/sync.rb

@@ -19,10 +19,17 @@ def work?
       end
 
       def enabled?
-        if APP_CONFIG("background.sync") == false
-          Rails.logger.warn("WARNING: Sync is disabled!")
+        if APP_CONFIG.enabled?("background.sync")
+          strategy = APP_CONFIG["background"]["sync"]["sync-strategy"]
+          if strategy == "initial" && Repository.any?
+            Rails.logger.info "`#{self}` was disabled because strategy is set to " \
+                              "'initial' and the database is not empty"
+            false
+          else
+            true
+          end
         else
-          APP_CONFIG("background.sync")
+          false
         end
       end
 

spec/lib/portus/background/registry_spec.rb

@@ -59,6 +59,18 @@
     end
   end
 
+  describe "#enabled?" do
+    it "returns true when enabled" do
+      APP_CONFIG["background"]["registry"] = { "enabled" => true }
+      expect(subject.enabled?).to be_truthy
+    end
+
+    it "returns false when not enabled" do
+      APP_CONFIG["background"]["registry"] = { "enabled" => false }
+      expect(subject.enabled?).to be_falsey
+    end
+  end
+
   describe "#to_s" do
     it "works" do
       expect(subject.to_s).to eq "Registry events"

spec/lib/portus/background/security_scanning_spec.rb

@@ -124,6 +124,21 @@
     end
   end
 
+  describe "#enabled?" do
+    it "returns true when enabled" do
+      expect(subject.enabled?).to be_truthy
+    end
+
+    it "returns false when not enabled" do
+      APP_CONFIG["security"] = {
+        "clair"  => { "server" => "" },
+        "zypper" => { "server" => "" },
+        "dummy"  => { "server" => "" }
+      }
+      expect(subject.enabled?).to be_falsey
+    end
+  end
+
   describe "#to_s" do
     it "works" do
       expect(subject.to_s).to eq "Security scanning"

spec/lib/portus/background/sync_spec.rb

@@ -189,6 +189,33 @@ def update_registry!(catalog)
     end
   end
 
+  describe "#enabled?" do
+    it "returns true when enabled" do
+      APP_CONFIG["background"]["sync"] = { "enabled" => true }
+      expect(subject.enabled?).to be_truthy
+    end
+
+    it "returns false when not enabled" do
+      APP_CONFIG["background"]["sync"] = { "enabled" => false }
+      expect(subject.enabled?).to be_falsey
+    end
+
+    it "returns false on initial if there are repositories" do
+      APP_CONFIG["background"]["sync"] = {
+        "enabled"       => true,
+        "sync-strategy" => "initial"
+      }
+
+      registry = create(:registry)
+      create(:user)
+      namespace = create(:namespace, registry: registry)
+      repo = create(:repository, name: "repo", namespace: namespace)
+      create(:tag, name: "tag", repository: repo)
+
+      expect(subject.enabled?).to be_falsey
+    end
+  end
+
   describe "#to_s" do
     it "works" do
       expect(subject.to_s).to eq "Registry synchronization"