nexus_seed 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc77af89892529f0462010fcb476a944738ffa595b31db3fdd6e5d241697a498
-  data.tar.gz: b70baa5184488918f26fc50536b8b3206a8ad3fc6a159d41a5e771f302c71773
+  metadata.gz: 3d0602fbc47d7d2441dfd389ee099c07c163ad9f9614733b44ade4c694e9de3b
+  data.tar.gz: 0eabcd944bafa8a1088e0bdf30d93fb5343f39fbbcb23eab0cef31a04754dfca
 SHA512:
-  metadata.gz: 23ba6a3fce2affaa629bae22b0e66acbeab6314ddb71490dd03e8f975a6f86634ae427611b5c7f14945b7c5753ca60fe8d100a05f8d0f9bc57ddf7f920491d3d
-  data.tar.gz: b55d81c2ccbf01d161d714252cb66d0d2cbca8e3072fcb2b6ef0f9ce52edab001d7fbc5c3f55b06f944dd3f6a741fe95054691afa717001cf1f9091adad3b221
+  metadata.gz: df29415b25122e1320693f78e36cf91b799943d5b21b1bea59f5ee23d188d2fd635345f1e8f90f73fef55477a2b951ef4aff955d6dea3a7382ea75bf9f5c706a
+  data.tar.gz: d7452164c0c606570e77146fc884450eb955e0bc14ee742f42061f0232e0da00aed365b3779212d54e656698d1736d21717054d6ea4689c20f08054ec6e28f90

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

@@ -10,7 +10,7 @@ module NexusSeed
         NexusSeed::Builder.destroy_seeds
       end
 
-      # Reset table sequences. Apparently rails looses track of a pk sequence if the pk value is inserted manually, e.g
+      # Reset table sequences. Apparently rails loses track of a pk sequence if the pk value is inserted manually, e.g
       # User.new(id: 1).save. When subsequently running User.create(), ActiveRecord should increment the id value to 2
       # by default, but turns out it will try to insert id: 1 again which will result in an error.
       #

data/lib/nexus_seed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSeed
-  # Leave this as 0.2.7 in order for CI process to replace with the tagged version.
-  VERSION = '0.2.7'
+  # Leave this as 0.2.9 in order for CI process to replace with the tagged version.
+  VERSION = '0.2.9'
 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,8 +26,12 @@ 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
-        seed
+        NexusSeed::Base.transaction do
+          seed
+        end
 
       elsif retries >= retry_limit && retry_limit != 0
         # log error stating seeding could not complete and task details
@@ -82,7 +86,7 @@ module NexusSeed
   end
 
   def logger
-    @@logger
+    @logger ||= SemanticLogger::Logger.new('NexusSeed')
   end
 
   def task_options(opts = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_seed
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexus_semantic_logger
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: seed usage for nexus