From 7868378406cd20e51b1a192e801361217fbd2239 Mon Sep 17 00:00:00 2001 From: Joe Rafaniello Date: Fri, 28 Jul 2017 14:50:43 -0400 Subject: [PATCH] Initial gem/repo infrastructure Much of the mechanics were modeled after the manageiq-automation_engine since it is also a Rails Engine but not a provider. Thanks Brandon. :tada: --- .codeclimate.yml | 47 +++++++ .gitignore | 12 ++ .rspec | 5 + .rspec_ci | 6 + .rubocop.yml | 4 + .rubocop_cc.yml | 5 + .rubocop_local.yml | 3 + .travis.yml | 22 ++++ Gemfile | 14 +++ LICENSE.txt | 202 ++++++++++++++++++++++++++++++ README.md | 29 +++++ Rakefile | 16 +++ bin/rails | 13 ++ bin/setup | 12 ++ bin/update | 14 +++ lib/manageiq-api.rb | 1 + lib/manageiq/api.rb | 1 + lib/manageiq/api/engine.rb | 15 +++ lib/manageiq/api/version.rb | 5 + lib/tasks/manageiq/api_tasks.rake | 4 + lib/tasks_private/spec.rake | 10 ++ manageiq-api.gemspec | 22 ++++ spec/spec_helper.rb | 9 ++ 23 files changed, 471 insertions(+) create mode 100644 .codeclimate.yml create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .rspec_ci create mode 100644 .rubocop.yml create mode 100644 .rubocop_cc.yml create mode 100644 .rubocop_local.yml create mode 100644 .travis.yml create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/rails create mode 100755 bin/setup create mode 100755 bin/update create mode 100644 lib/manageiq-api.rb create mode 100644 lib/manageiq/api.rb create mode 100644 lib/manageiq/api/engine.rb create mode 100644 lib/manageiq/api/version.rb create mode 100644 lib/tasks/manageiq/api_tasks.rake create mode 100644 lib/tasks_private/spec.rake create mode 100644 manageiq-api.gemspec create mode 100644 spec/spec_helper.rb diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 0000000000..0de35ec210 --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,47 @@ +--- +exclude_paths: +- ".git/" +- "**.xml" +- "**.yaml" +- "**.yml" +- "locale/" +- "spec/" +- "tools/" +engines: + brakeman: + # very slow :sad_panda: + enabled: false + bundler-audit: + # requires Gemfile.lock + enabled: false + csslint: + enabled: false + duplication: + enabled: true + config: + languages: + - ruby + - javascript + eslint: + enabled: false + channel: "eslint-3" + fixme: + # let's enable later + enabled: false + markdownlint: + # let's enable later + enabled: false + rubocop: + enabled: true + config: '.rubocop_cc.yml' +prepare: + fetch: + - url: "https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml" + path: ".rubocop_base.yml" + - url: "https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_cc_base.yml" + path: ".rubocop_cc_base.yml" +ratings: + paths: + - Gemfile.lock + - "**.rake" + - "**.rb" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..6dfebb00ae --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +.rubocop-* +/.bundle/ +/.yardoc +/Gemfile.lock +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +/spec/manageiq diff --git a/.rspec b/.rspec new file mode 100644 index 0000000000..30a045574b --- /dev/null +++ b/.rspec @@ -0,0 +1,5 @@ +--require manageiq/spec/spec_helper +--require spec_helper +--color +--order random +--exclude-pattern "spec/manageiq/**/*_spec.rb" diff --git a/.rspec_ci b/.rspec_ci new file mode 100644 index 0000000000..7eddca123b --- /dev/null +++ b/.rspec_ci @@ -0,0 +1,6 @@ +--require manageiq/spec/spec_helper +--require spec_helper +--color +--order random +--exclude-pattern "spec/manageiq/**/*_spec.rb" +--profile 25 diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000000..4c9381b2ea --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,4 @@ +inherit_from: +- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml +# put all local rubocop config into .rubocop_local.yml as it will be loaded by .rubocop_cc.yml as well +- .rubocop_local.yml diff --git a/.rubocop_cc.yml b/.rubocop_cc.yml new file mode 100644 index 0000000000..ff96a0cba6 --- /dev/null +++ b/.rubocop_cc.yml @@ -0,0 +1,5 @@ +inherit_from: +# this is downloaded by .codeclimate.yml +- .rubocop_base.yml +- .rubocop_cc_base.yml +- .rubocop_local.yml diff --git a/.rubocop_local.yml b/.rubocop_local.yml new file mode 100644 index 0000000000..a6d95740f1 --- /dev/null +++ b/.rubocop_local.yml @@ -0,0 +1,3 @@ +GlobalVars: + AllowedVariables: + - $evm diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..0d227b582a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,22 @@ +language: ruby +rvm: +- '2.3.1' +- '2.4.1' +sudo: false +cache: bundler +env: + global: + - RUBY_GC_HEAP_GROWTH_MAX_SLOTS=300000 + - RUBY_GC_HEAP_INIT_SLOTS=600000 + - RUBY_GC_HEAP_GROWTH_FACTOR=1.25 +addons: + postgresql: '9.4' +install: bin/setup +after_script: bundle exec codeclimate-test-reporter +notifications: + webhooks: + urls: + - https://webhooks.gitter.im/e/46abb9c5f1f009b6a699 + on_success: change + on_failure: always + on_start: never diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000000..249e5a2837 --- /dev/null +++ b/Gemfile @@ -0,0 +1,14 @@ +source 'https://rubygems.org' + +gemspec + +# Load Gemfile with dependencies from manageiq +manageiq_gemfile = File.expand_path("spec/manageiq/Gemfile", __dir__) +if File.exist?(manageiq_gemfile) + eval_gemfile(manageiq_gemfile) +else + puts "ERROR: The ManageIQ application must be present in spec/manageiq." + puts " Clone it from GitHub or symlink it from local source." + exit 1 +end + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..f431055de6 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# ManageIQ::Api +Short description and motivation. + +## Usage +How to use my plugin. + +## Installation +Add this line to your application's Gemfile: + +```ruby +gem 'manageiq-api' +``` + +And then execute: +```bash +$ bundle +``` + +Or install it yourself as: +```bash +$ gem install manageiq-api +``` + +## Contributing +Contribution directions go here. + +## License + +See [LICENSE.txt](LICENSE.txt). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000000..452f0b4736 --- /dev/null +++ b/Rakefile @@ -0,0 +1,16 @@ +require 'bundler/setup' + +begin + require 'rspec/core/rake_task' + + APP_RAKEFILE = File.expand_path("../spec/manageiq/Rakefile", __FILE__) + load 'rails/tasks/engine.rake' + load 'rails/tasks/statistics.rake' +rescue LoadError +end + +require 'bundler/gem_tasks' + +FileList['lib/tasks_private/**/*.rake'].each { |r| load r } + +task :default => :spec diff --git a/bin/rails b/bin/rails new file mode 100755 index 0000000000..47118324dc --- /dev/null +++ b/bin/rails @@ -0,0 +1,13 @@ +#!/usr/bin/env ruby +# This command will automatically be run when you run "rails" with Rails gems +# installed from the root of your application. + +ENGINE_ROOT = File.expand_path('../..', __FILE__) +ENGINE_PATH = File.expand_path('../../lib/manageiq/api/engine', __FILE__) + +# Set up gems listed in the Gemfile. +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) +require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE']) + +require 'rails/all' +require 'rails/engine/commands' diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000000..5074d168c9 --- /dev/null +++ b/bin/setup @@ -0,0 +1,12 @@ +#!/usr/bin/env ruby +require 'pathname' + +gem_root = Pathname.new(__dir__).join("..") + +unless gem_root.join("spec/manageiq").exist? + puts "== Cloning manageiq sample app ==" + system "git clone https://github.com/ManageIQ/manageiq.git --depth 1 spec/manageiq" +end + +require gem_root.join("spec/manageiq/lib/manageiq/environment").to_s +ManageIQ::Environment.manageiq_plugin_setup diff --git a/bin/update b/bin/update new file mode 100755 index 0000000000..417a86127c --- /dev/null +++ b/bin/update @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby +require 'pathname' + +gem_root = Pathname.new(__dir__).join("..") + +if gem_root.join("spec/manageiq").symlink? + puts "== SKIPPING update of spec/manageiq because its symlinked ==" +else + puts "== Updating manageiq sample app ==" + system("git pull", :chdir => gem_root.join("spec/manageiq")) +end + +require gem_root.join("spec/manageiq/lib/manageiq/environment").to_s +ManageIQ::Environment.manageiq_plugin_setup diff --git a/lib/manageiq-api.rb b/lib/manageiq-api.rb new file mode 100644 index 0000000000..3eff858bcf --- /dev/null +++ b/lib/manageiq-api.rb @@ -0,0 +1 @@ +require 'manageiq/api' diff --git a/lib/manageiq/api.rb b/lib/manageiq/api.rb new file mode 100644 index 0000000000..a9373013f6 --- /dev/null +++ b/lib/manageiq/api.rb @@ -0,0 +1 @@ +require "manageiq/api/engine" diff --git a/lib/manageiq/api/engine.rb b/lib/manageiq/api/engine.rb new file mode 100644 index 0000000000..9887052b94 --- /dev/null +++ b/lib/manageiq/api/engine.rb @@ -0,0 +1,15 @@ +require 'rails/engine' +module ManageIQ + module Api + class Engine < ::Rails::Engine + isolate_namespace ManageIQ::Api + config.autoload_paths << File.expand_path(root.join('app', 'controllers', 'api'), __FILE__) + config.autoload_paths << File.expand_path(root.join('lib', 'services'), __FILE__) + config.autoload_paths << File.expand_path(root.join('lib'), __FILE__) + + def vmdb_plugin? + true + end + end + end +end diff --git a/lib/manageiq/api/version.rb b/lib/manageiq/api/version.rb new file mode 100644 index 0000000000..078cc81915 --- /dev/null +++ b/lib/manageiq/api/version.rb @@ -0,0 +1,5 @@ +module ManageIQ + module Api + VERSION = "3.0.0-pre".freeze + end +end diff --git a/lib/tasks/manageiq/api_tasks.rake b/lib/tasks/manageiq/api_tasks.rake new file mode 100644 index 0000000000..778cd0075c --- /dev/null +++ b/lib/tasks/manageiq/api_tasks.rake @@ -0,0 +1,4 @@ +# desc "Explaining what the task does" +# task :manageiq_api do +# # Task goes here +# end diff --git a/lib/tasks_private/spec.rake b/lib/tasks_private/spec.rake new file mode 100644 index 0000000000..a300b6bf8f --- /dev/null +++ b/lib/tasks_private/spec.rake @@ -0,0 +1,10 @@ +namespace :spec do + desc "Setup environment specs" + task :setup => ["app:test:initialize", "app:test:verify_no_db_access_loading_rails_environment", "app:test:setup_db"] +end + +desc "Run all specs" +RSpec::Core::RakeTask.new(:spec => ["app:test:initialize", "app:evm:compile_sti_loader"]) do |t| + spec_dir = File.expand_path("../../spec", __dir__) + EvmTestHelper.init_rspec_task(t, ['--require', File.join(spec_dir, 'spec_helper')]) +end diff --git a/manageiq-api.gemspec b/manageiq-api.gemspec new file mode 100644 index 0000000000..e0a88128ef --- /dev/null +++ b/manageiq-api.gemspec @@ -0,0 +1,22 @@ +$:.push File.expand_path("../lib", __FILE__) + +# Maintain your gem's version: +require "manageiq/api/version" + +# Describe your gem and declare its dependencies: +Gem::Specification.new do |s| + s.name = "manageiq-api" + s.version = ManageIQ::Api::VERSION + s.authors = ["ManageIQ Developers"] + s.homepage = "https://github.com/ManageIQ/manageiq-api" + s.summary = "The ManageIQ Api" + s.description = "The ManageIQ Api" + s.licenses = ["Apache-2.0"] + + s.files = Dir["{app,lib}/**/*", "LICENSE.txt", "Rakefile", "README.md"] + + s.add_dependency "config" + + s.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0" + s.add_development_dependency "simplecov" +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000000..caf4acc8ef --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,9 @@ +if ENV['CI'] + require 'simplecov' + SimpleCov.start +end + +require 'manageiq-api' + +Dir[ManageIQ::Api::Engine.root.join("spec/support/**/*.rb")].each { |f| require f } +Dir[Rails.root.join("spec/shared/**/*.rb")].each { |f| require f }