fedora-migrate 0.1.0 → 0.2.0

data/lib/fedora_migrate/repository_migrator.rb

@@ -3,53 +3,63 @@ module FedoraMigrate
 
     include MigrationOptions
 
-    attr_accessor :source_objects, :namespace, :failed
+    attr_accessor :source_objects, :namespace, :report
+
+    SingleObjectReport = Struct.new(:status, :object, :relationships)
 
     def initialize namespace = nil, options = {}
       @namespace = namespace || repository_namespace
       @options = options
-      @failed = 0
+      @report = MigrationReport.new(@options.fetch(:report, nil))
       @source_objects = get_source_objects
       conversion_options
     end
 
-    # TODO: need a reporting mechanism for results (issue #4)
     def migrate_objects
       source_objects.each { |source| migrate_object(source) }
-      @failed == 0
     end
 
-    # TODO: need a reporting mechanism for results (issue #4)
     def migrate_relationships
-      return "Relationship migration halted because #{failed.to_s} objects didn't migrate successfully." if failed > 0 && not_forced?
+      return "Relationship migration halted because #{failures.to_s} objects didn't migrate successfully." if failures > 0 && not_forced?
       source_objects.each { |source| migrate_relationship(source) }
-      @failed == 0
     end
 
     def get_source_objects
-      FedoraMigrate.source.connection.search(nil).collect { |o| qualifying_object(o) }.compact
+      if report.empty?
+        FedoraMigrate.source.connection.search(nil).collect { |o| qualifying_object(o) }.compact
+      else
+        report.failed_objects.map { |o| FedoraMigrate.source.connection.find(o) }
+      end
+    end
+
+    def failures
+      report.failed_objects.count
     end
 
     private
 
     def migrate_object source
-      Logger.info "Migrating source object #{source.pid}"
-      FedoraMigrate::ObjectMover.new(source, nil, options).migrate
-    rescue StandardError => e
-      Logger.warn "#{source.pid} failed.\n#{error_message(e)}"
-      @failed = @failed + 1
+      object_report = SingleObjectReport.new
+      begin
+        object_report.object = FedoraMigrate::ObjectMover.new(source, nil, options).migrate
+        object_report.status = true
+      rescue StandardError => e
+        object_report.object = e.inspect
+        object_report.status = false
+      end
+      report.results[source.pid] = object_report
     end
 
     def migrate_relationship source
-      Logger.info "Migrating relationships for source object #{source.pid}"
-      FedoraMigrate::RelsExtDatastreamMover.new(source).migrate
-    rescue StandardError => e
-      Logger.warn "#{source.pid} relationship migration failed.\n#{error_message(e)}"
-      @failed = @failed + 1
-    end
-
-    def error_message e
-      [e.inspect, e.backtrace.join("\n\t")].join("\n\t")
+      relationship_report = find_or_create_single_object_report(source)
+      begin
+        relationship_report.relationships = FedoraMigrate::RelsExtDatastreamMover.new(source).migrate
+        relationship_report.status = true
+      rescue StandardError => e
+        relationship_report.relationships = e.inspect
+        relationship_report.status = false
+      end
+      report.results[source.pid] = relationship_report
     end
 
     def repository_namespace
@@ -61,5 +71,8 @@ module FedoraMigrate
       return object if name.match(namespace)
     end
 
+    def find_or_create_single_object_report source
+      report.results[source.pid] || SingleObjectReport.new
+    end
   end
 end

data/lib/fedora_migrate/target_constructor.rb

@@ -30,9 +30,8 @@ module FedoraMigrate
 
     def vet model
       @target = FedoraMigrate::Mover.id_component(model).constantize
-      Logger.info "using #{model} for target"
     rescue NameError
-      Logger.info "rejecting #{model} for target"
+      Logger.debug "rejecting #{model} for target"
     end
 
   end

data/lib/fedora_migrate/version.rb

@@ -1,3 +1,3 @@
 module FedoraMigrate
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tasks/fedora-migrate.rake

@@ -8,8 +8,8 @@ namespace :fedora do
   namespace :migrate do
     desc "Migrates all objects in a Sufia-based application"
     task sufia: :environment do
-      results = FedoraMigrate.migrate_repository(namespace: "sufia", options: {convert: "descMetadata"})
-      puts results
+      migrator = FedoraMigrate.migrate_repository(namespace: "sufia", options: {convert: "descMetadata"})
+      migrator.report.save
     end
 
     desc "Migrates only relationships in a Sufia-based application"
@@ -39,6 +39,12 @@ namespace :fedora do
       raise "Please provide a pid, example changeme:1234" if args[:pid].nil?
       FedoraMigrate::RelsExtDatastreamMover.new(FedoraMigrate.source.connection.find(args[:pid])).migrate
     end
+
+    desc "Report the results of a migration"
+    task :report, [:file] => :environment do |t, args|
+      raise "Please provide a path to a report.json file" if args[:file].nil?
+      FedoraMigrate::MigrationReport.new(args[:file]).report_failures
+    end
   
   end
 

data/spec/fixtures/failed-report.json

@@ -0,0 +1,339 @@
+{
+  "sufia:5m60qr94g": {
+    "status": false,
+    "object": "Sample object migration failure",
+    "relationships": [
+
+    ]
+  },
+  "sufia:5m60qr95r": {
+    "status": true,
+    "object": {
+      "id": "5m60qr95r",
+      "class": "GenericFile",
+      "content_datastreams": [
+        {
+          "ds": "content",
+          "versions": [
+            {
+              "name": "file2.txt",
+              "mime_type": "text/plain",
+              "original_date": "2015-01-19T21:32:47Z"
+            }
+          ]
+        },
+        {
+          "ds": "thumbnail",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        },
+        {
+          "ds": "characterization",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        }
+      ],
+      "rdf_datastreams": [
+        {
+          "ds": "descMetadata",
+          "status": [
+
+          ]
+        }
+      ],
+      "permissions": [
+        "read_groups = []",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"awead@psu.edu\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+      "http://localhost:8983/fedora/rest/test/5m60qr95r--info:fedora/fedora-system:def/relations-external#isPartOf--http://localhost:8983/fedora/rest/test/5m60qr94g"
+    ]
+  },
+  "sufia:5m60qr961": {
+    "status": true,
+    "object": {
+      "id": "5m60qr961",
+      "class": "GenericFile",
+      "content_datastreams": [
+        {
+          "ds": "content",
+          "versions": [
+            {
+              "name": "file1.txt",
+              "mime_type": "text/plain",
+              "original_date": "2015-01-19T21:32:49Z"
+            }
+          ]
+        },
+        {
+          "ds": "thumbnail",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        },
+        {
+          "ds": "characterization",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        }
+      ],
+      "rdf_datastreams": [
+        {
+          "ds": "descMetadata",
+          "status": [
+
+          ]
+        }
+      ],
+      "permissions": [
+        "read_groups = []",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"awead@psu.edu\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+      "http://localhost:8983/fedora/rest/test/5m60qr961--info:fedora/fedora-system:def/relations-external#isPartOf--http://localhost:8983/fedora/rest/test/5m60qr94g"
+    ]
+  },
+  "sufia:5m60qr979": {
+    "status": true,
+    "object": {
+      "id": "5m60qr979",
+      "class": "Collection",
+      "content_datastreams": [
+
+      ],
+      "rdf_datastreams": [
+        {
+          "ds": "descMetadata",
+          "status": [
+
+          ]
+        }
+      ],
+      "permissions": [
+        "read_groups = [\"public\"]",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"awead@psu.edu\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": "2015-01-19T21:34:23.805Z",
+        "modified": "2015-03-03T18:48:51.16Z"
+      }
+    },
+    "relationships": [
+      "http://localhost:8983/fedora/rest/test/5m60qr979--info:fedora/fedora-system:def/relations-external#hasCollectionMember--http://localhost:8983/fedora/rest/test/5m60qr95r",
+      "http://localhost:8983/fedora/rest/test/5m60qr979--info:fedora/fedora-system:def/relations-external#hasCollectionMember--http://localhost:8983/fedora/rest/test/5m60qr961"
+    ]
+  },
+  "sufia:rb68xc089": {
+    "status": false,
+    "object": "Sample object migration failure",
+    "relationships": [
+
+    ]
+  },
+  "sufia:rb68xc09k": {
+    "status": true,
+    "object": {
+      "id": "rb68xc09k",
+      "class": "Batch",
+      "content_datastreams": [
+
+      ],
+      "rdf_datastreams": [
+
+      ],
+      "permissions": null,
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+
+    ]
+  },
+  "sufia:rb68xc10b": {
+    "status": true,
+    "object": {
+      "id": "rb68xc10b",
+      "class": "GenericFile",
+      "content_datastreams": [
+        {
+          "ds": "content",
+          "versions": [
+
+          ]
+        },
+        {
+          "ds": "thumbnail",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        },
+        {
+          "ds": "characterization",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        }
+      ],
+      "rdf_datastreams": [
+
+      ],
+      "permissions": [
+        "read_groups = []",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"jilluser@example.com\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+      "http://localhost:8983/fedora/rest/test/rb68xc10b--info:fedora/fedora-system:def/relations-external#isPartOf--http://localhost:8983/fedora/rest/test/rb68xc09k"
+    ]
+  },
+  "sufia:rb68xc11m": {
+    "status": true,
+    "object": {
+      "id": "rb68xc11m",
+      "class": "GenericFile",
+      "content_datastreams": [
+        {
+          "ds": "content",
+          "versions": [
+
+          ]
+        },
+        {
+          "ds": "thumbnail",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        },
+        {
+          "ds": "characterization",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        }
+      ],
+      "rdf_datastreams": [
+
+      ],
+      "permissions": [
+        "read_groups = []",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"otherUser\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+      "http://localhost:8983/fedora/rest/test/rb68xc11m--info:fedora/fedora-system:def/relations-external#isPartOf--http://localhost:8983/fedora/rest/test/rb68xc09k"
+    ]
+  },
+  "sufia:xp68km39w": {
+    "status": true,
+    "object": {
+      "id": "xp68km39w",
+      "class": "GenericFile",
+      "content_datastreams": [
+        {
+          "ds": "content",
+          "versions": [
+
+          ]
+        },
+        {
+          "ds": "thumbnail",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        },
+        {
+          "ds": "characterization",
+          "versions": [
+            {
+              "error": "Nil source -- it's probably defined in the target but not present in the source"
+            }
+          ]
+        }
+      ],
+      "rdf_datastreams": [
+        {
+          "ds": "descMetadata",
+          "status": [
+
+          ]
+        }
+      ],
+      "permissions": [
+        "read_groups = []",
+        "edit_groups = []",
+        "discover_groups = []",
+        "read_users = []",
+        "edit_users = [\"awead@psu.edu\"]",
+        "discover_users = []"
+      ],
+      "dates": {
+        "uploaded": null,
+        "modified": null
+      }
+    },
+    "relationships": [
+
+    ]
+  }
+}