Add support for exporting and importing generic object definitions #18688

romanblanco · 2019-04-25T13:28:31Z

These rake scripts and classes provide functionality for exporting/importing of the Generic Object Definitions.

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1595259

Assuming the generic object definitions are all created by user, and therefore there are no default / custom generic object definitions.
For that reason, we don't work with --all argument as can be seen in other ManageIQ exportable objects.

While importing, the overwrite switch defaults to true. To disable overwriting of imported objects use --no-overwrite switch.

Links

Steps for Testing/QA

Exporting

Create a directory for the exports

mkdir tmp/generic_object_definitions

Export user defined

bin/rake evm:export:generic_object_definitions -- --directory tmp/generic_object_definitions

Importing

Import all generic object definition yaml files in a directory

bin/rake evm:import:generic_object_definitions -- --source tmp/generic_object_definitions

Import a specific generic object definition yaml file

bin/rake evm:import:generic_object_definitions -- --source tmp/generic_object_definitions/god_runtime_error.yml

romanblanco · 2019-04-25T13:29:29Z

@miq-bot add_label enhancement tools
/cc @gmcculloug @gtanzillo

miq-bot · 2019-04-25T13:30:36Z

@romanblanco Cannot apply the following label because they are not recognized: enhancement tools

Fryguy · 2019-04-26T15:15:31Z

spec/lib/task_helpers/imports/data/generic_object_definitions/apep.yaml

+---
+- GenericObjectDefinition:
+    name: Apep
+    description: Ancient Egyptian deity who embodied chaos


LOOOL. I love this.

Fryguy · 2019-04-26T15:16:41Z

app/models/generic_object_definition.rb

@@ -21,6 +23,7 @@ class GenericObjectDefinition < ApplicationRecord
  REG_ATTRIBUTE_NAME = /\A[a-z][a-zA-Z_0-9]*\z/
  REG_METHOD_NAME    = /\A[a-z][a-zA-Z_0-9]*[!?]?\z/
  ALLOWED_ASSOCIATION_TYPES = (MiqReport.reportable_models + %w(GenericObject)).freeze
+  IMPORT_CLASS_NAMES = %w(GenericObjectDefinition).freeze


Is this used anywhere?

@Fryguy yes, to validate the imported data

Fryguy · 2019-04-26T15:17:24Z

@gtanzillo Please review.

gmcculloug

@eclarizio can you help review this one?

gmcculloug · 2019-04-26T16:03:19Z

spec/models/miq_report/import_export_spec.rb

@@ -18,7 +18,7 @@
    before do
      @user_admin = FactoryBot.create(:user_admin)
      report_string = MiqReport.export_to_yaml([@old_report.id], MiqReport)
-      @new_report   = YAML.load(report_string).first
+      @new_report   = YAML.load(report_string).first["MiqReport"]


These report changes should be moved to a separate PR to keep this GenericObject focused.

gmcculloug · 2019-04-26T16:07:03Z

spec/lib/task_helpers/imports/generic_object_definitions_spec.rb

+      end
+    end
+
+    describe "when the source file modifies an existing report" do


Several references to report here which seem like remnants from copy/paste.

eclarizio

The code seems fine, but you could probably separate the new methods in GenericObjectDefinition into a mixin since that seems to be the pattern we have for MiqWidget, MiqReport, and MiqPolicy. They all just have an ImportExport module with at least the import_from_hash and export_to_array methods in them, and then the object in question just does include_concern 'ImportExport'.

miq-bot · 2019-04-30T08:00:59Z

Checked commits romanblanco/manageiq@fc78b82~...77e1879 with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
7 files checked, 0 offenses detected
Everything looks fine. 🏆

eclarizio

👍

d-m-u · 2019-05-02T12:03:30Z

Just fyi the description of the commands looks copypasted with an error:
bin/rake evm:export:generic_object_definitions -- --directory tmp/generic_object_definitions
and your import command is
bin/rake evm:export:generic_object_definitions -- --directory /tmp/generic_object_definitions

(you should probably take the slash off the import command line in the description)

romanblanco force-pushed the bz1595259 branch from 02b898f to 4d28a12 Compare April 26, 2019 13:04

Fryguy assigned gtanzillo Apr 26, 2019

Fryguy reviewed Apr 26, 2019

View reviewed changes

gmcculloug added the enhancement label Apr 26, 2019

gmcculloug assigned gmcculloug and unassigned gtanzillo Apr 26, 2019

gmcculloug reviewed Apr 26, 2019

View reviewed changes

romanblanco force-pushed the bz1595259 branch from 70b218f to 7f9d2b1 Compare April 29, 2019 12:56

Export GenericObjectDefinitions

fc78b82

romanblanco force-pushed the bz1595259 branch 2 times, most recently from fe74675 to 0278221 Compare April 29, 2019 13:03

romanblanco and others added 2 commits April 29, 2019 13:36

Import GenericObjectDefinitions

621c18c

Specs for the import/export of the Generic Object Definitions.

215e39b

romanblanco force-pushed the bz1595259 branch from 0278221 to 215e39b Compare April 29, 2019 13:36

eclarizio suggested changes Apr 29, 2019

View reviewed changes

Review response: Import/Export methods extracted into a mixin

77e1879

eclarizio approved these changes Apr 30, 2019

View reviewed changes

gmcculloug requested a review from d-m-u May 2, 2019 11:47

d-m-u approved these changes May 2, 2019

View reviewed changes

gmcculloug merged commit da7225f into ManageIQ:master May 2, 2019

gmcculloug added this to the Sprint 111 Ending May 13, 2019 milestone May 2, 2019

gmcculloug added the changelog/yes label May 2, 2019

romanblanco deleted the bz1595259 branch May 2, 2019 15:10

branic mentioned this pull request May 2, 2019

Implement export/import functionality of Miq objects via command-line #15350

Open

18 tasks

john-dupuy mentioned this pull request Jun 3, 2019

[1LP][RFR] Automate import/export of generic object definitions ManageIQ/integration_tests#8897

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for exporting and importing generic object definitions #18688

Add support for exporting and importing generic object definitions #18688

romanblanco commented Apr 25, 2019 •

edited

Loading

romanblanco commented Apr 25, 2019

miq-bot commented Apr 25, 2019

Fryguy Apr 26, 2019

Fryguy Apr 26, 2019

romanblanco Apr 29, 2019

Fryguy commented Apr 26, 2019

gmcculloug left a comment

gmcculloug Apr 26, 2019

gmcculloug Apr 26, 2019

eclarizio left a comment

miq-bot commented Apr 30, 2019

eclarizio left a comment

d-m-u commented May 2, 2019 •

edited

Loading

Add support for exporting and importing generic object definitions #18688

Add support for exporting and importing generic object definitions #18688

Conversation

romanblanco commented Apr 25, 2019 • edited Loading

Links

Steps for Testing/QA

romanblanco commented Apr 25, 2019

miq-bot commented Apr 25, 2019

Fryguy Apr 26, 2019

Choose a reason for hiding this comment

Fryguy Apr 26, 2019

Choose a reason for hiding this comment

romanblanco Apr 29, 2019

Choose a reason for hiding this comment

Fryguy commented Apr 26, 2019

gmcculloug left a comment

Choose a reason for hiding this comment

gmcculloug Apr 26, 2019

Choose a reason for hiding this comment

gmcculloug Apr 26, 2019

Choose a reason for hiding this comment

eclarizio left a comment

Choose a reason for hiding this comment

miq-bot commented Apr 30, 2019

eclarizio left a comment

Choose a reason for hiding this comment

d-m-u commented May 2, 2019 • edited Loading

romanblanco commented Apr 25, 2019 •

edited

Loading

d-m-u commented May 2, 2019 •

edited

Loading