nexus_seed 0.2.8 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c30412d463327ee535c5abe6862a2c7079726562cd6bc1dcb359e5e719c242c
-  data.tar.gz: 1dbed102d6cb21ee5eb8c2958ef844f011303f529413d5e75d11b8ae0cd932e6
+  metadata.gz: 61cc46080bca8e537d0290de925e2c4a24ec08251f4613af77233712bfc87368
+  data.tar.gz: 7a192d784f4baf6b2e5eee0b553c2c12f12b08f97c81c1f58ef897e01273e648
 SHA512:
-  metadata.gz: c3dbcec4ca06afbda2e4f64f1ad6324f99be0a350e43cc25ce83d0db40cc576e1a8861fb92851e2d0cef066335903633d764a672f9141be969b4d4fcdde8316f
-  data.tar.gz: 5bee9f4dfd6b6634a17af5cbf60d17b38199a30629d16718339dd98843a0c1a3307f643c2475124a9ec2690ff8708ebfd87912cb03b1f4c01743b8b5e6c3b91b
+  metadata.gz: faefc536924c2c8341c0722b06b9b5ccdddb11458db2985381a73dcb9596eae90ce787fc31a34aa7145bf0c24a6dd72169c6d07d6a76f65ad922162d6a2b419a
+  data.tar.gz: 919c1c15889cb931610e60d677b122df71476b3650f2baa6a65385d9921086b36ace17b0d4b6dd260f2811b1be4b3de9a2506f6231e2d81d377195f96cb7f978

data/README.md

@@ -1,3 +1,75 @@
 # nexus_seed
 
 Common rails application seeding logic.
+
+# Running
+
+## Running tasks on deploy
+
+Task files must be placed in `/lib/tasks/seed_#{name}.rake`
+
+Set task name in helm values e.g. for a `common` seed task:
+
+```
+helm:
+  values:
+    rails:
+      seedTasks:
+        - common
+```
+
+Configure the post deploy hook in `devspace.yaml` and set `COMPONENT` appropriately:
+
+```
+hooks:
+  - name: post-deploy-seed-task-hook
+    events: [ "after:deploy" ]
+    command: |-
+      docker run --rm --pull always registry.nexusmods.com/nexus-mods/devops/tools/seed_task_start:stable cat seed_task_start.sh |
+      NAMESPACE=${devspace.namespace} COMPONENT=api bash
+```
+
+## Running tasks manually
+
+Run `common` seed task with default options:
+
+`bundle exec rake seed_common:run`
+
+Options are `[:retry_limit, :sleep_interval]`
+
+E.g. to retry 100 times every 3 seconds:
+
+`bundle exec rake seed_common:run[100,3]`
+
+# Local gem development
+
+Steps to run this gem from local sources in one the nexus 'staged build' rails components:
+
+## Copy gem sources to component
+
+```
+cd ~/nexus-api
+cp -r ../nexus_seed .
+```
+
+## Adjust component Dockerfile to include gem sources
+
+Within stage 1, append a COPY after the Gemfile copy:
+
+```
+COPY --chown=nexus:nexus Gemfile* ./
+COPY --chown=nexus:nexus nexus_seed/ ./nexus_seed/
+```
+
+Within stage 2, append a COPY after the bundle copy:
+
+```
+COPY --from=stage1 /usr/local/bundle /usr/local/bundle
+COPY --from=stage1 /app/nexus_seed/ /app/nexus_seed/
+```
+
+## Adjust Gemfile to use local path
+
+```
+gem 'nexus_seed', :path => "/app/nexus_seed"
+```

data/lib/nexus_seed/base.rb

@@ -6,7 +6,7 @@ module NexusSeed
 
       NexusSeed::Builder.seed_report
 
-      if ENV['destroy_seeds']
+      if ENV['NEXUS_SEED_DESTROY']
         NexusSeed::Builder.destroy_seeds
       end
 

data/lib/nexus_seed/builder.rb

@@ -5,14 +5,17 @@ module NexusSeed
     @counts = {}
     @start = Time.now
     @seeds = []
-    @logger = Logger.new(STDOUT)
+
+    def self.logger
+      @logger ||= SemanticLogger::Logger.new('NexusSeed::Builder')
+    end
 
     def self.build_called
       @build_called
     end
 
     def self.build(class_name, params = {}, options = {})
-      if ENV['seed_report']
+      if ENV['NEXUS_SEED_REPORT']
         pre_seed_counts unless @build_called
       end
 
@@ -21,25 +24,25 @@ module NexusSeed
     end
 
     def self.seed_report
-      if ENV['seed_report']
+      if ENV['NEXUS_SEED_REPORT']
         total = 0
 
-        @logger.info('SEED REPORT:')
+        logger.info('SEED REPORT:')
         NexusSeed::Builders.constants.select do |c|
           NexusSeed::Builders.const_get(c).is_a?(Class)
           k = NexusSeed::Builders.const_get(c).new.send(:klass)
           if @counts[k.name.demodulize] != k.count
             total += (k.count - @counts[k.name.demodulize])
-            @logger.info("Generated #{k.count - @counts[k.name.demodulize]} new #{k.name.demodulize}s")
+            logger.info("Generated #{k.count - @counts[k.name.demodulize]} new #{k.name.demodulize}s")
           end
         end
 
-        @logger.info("Generated total of #{total} new seeds.")
+        logger.info("Generated total of #{total} new seeds.")
       else
-        @logger.info('Seeding completed.')
+        logger.info('Seeding completed.')
       end
 
-      @logger.info("Time: #{(Time.now - @start).round(2)}s")
+      logger.info("Time: #{(Time.now - @start).round(2)}s")
     end
 
     def self.add_seed(seed)
@@ -53,7 +56,7 @@ module NexusSeed
           count += 1
           seed.destroy
         end
-        @logger.info("Destroyed #{count} seeds (including dependants). All seeds deleted.")
+        logger.info("Destroyed #{count} seeds (including dependants). All seeds deleted.")
       end
     end
 

data/lib/nexus_seed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSeed
-  # Leave this as 0.2.8 in order for CI process to replace with the tagged version.
-  VERSION = '0.2.8'
+  # Leave this as 0.2.10 in order for CI process to replace with the tagged version.
+  VERSION = '0.2.10'
 end

data/lib/nexus_seed.rb

@@ -7,10 +7,9 @@ require 'nexus_seed/base'
 
 module NexusSeed
   # defaults
-  @@retry_limit = 0
+  @@retry_limit = 12
   @@sleep_interval = 5
   @@retries = 0
-  @@logger = SemanticLogger::Logger.new('NexusSeed')
 
   # override this method with your specific requirement
   def requires
@@ -18,6 +17,7 @@ module NexusSeed
   end
 
   def run
+    logger.info('Run with options:', limit: retry_limit, interval: sleep_interval)
     logger.measure_info('Total seed run.') do
       _run_internal
     end
@@ -26,6 +26,8 @@ module NexusSeed
   # recursively called until requirement is met or the limit is reached
   def _run_internal
     if Rails.env.test? || Rails.env.development?
+
+      logger.info("Starting run attempt #{retries + 1}")
       if requires
         NexusSeed::Base.transaction do
           seed
@@ -84,7 +86,7 @@ module NexusSeed
   end
 
   def logger
-    @@logger
+    @logger ||= SemanticLogger::Logger.new('NexusSeed')
   end
 
   def task_options(opts = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_seed
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.10
 platform: ruby
 authors:
 - Johnathon Harris