foreman_google 0.0.1

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanGoogle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/controllers/concerns/foreman_google/temporary_prepend_path.rb

@@ -0,0 +1,16 @@
+module ForemanGoogle
+  # This module prepends core paths so view for gce takes precedence over core ones
+  # This module NEEDS to get deleted once the core support for gce is dropped.
+  # or this plugin is merged to core
+  module TemporaryPrependPath
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :prepare_views
+    end
+
+    def prepare_views
+      prepend_view_path ForemanGoogle::Engine.root.join('app', 'views')
+    end
+  end
+end

data/app/models/foreman_google/gce.rb

@@ -0,0 +1,119 @@
+require 'foreman_google/google_compute_adapter'
+
+module ForemanGoogle
+  class GCE < ::ComputeResource
+    def self.available?
+      true
+    end
+
+    def self.provider_friendly_name
+      'Google'
+    end
+
+    def user_data_supported?
+      true
+    end
+
+    def test_connection(options = {})
+    end
+
+    def to_label
+    end
+
+    def capabilities
+      %i[image new_volume]
+    end
+
+    def zones
+      client.zones.map(&:name)
+    end
+    alias_method :available_zones, :zones
+
+    def zone
+      url
+    end
+
+    def zone=(zone)
+      self.url = zone
+    end
+
+    def networks
+      client.networks.map(&:name)
+    end
+
+    def available_networks(_cluster_id = nil)
+      client.networks.items
+    end
+
+    def machine_types
+      client.machine_types(zone)
+    end
+    alias_method :available_flavors, :machine_types
+
+    def disks
+    end
+
+    # def interfaces_attrs_name
+    #   super # :interfaces
+    # end
+
+    # This should return interface compatible with Fog::Server
+    # implemented by ForemanGoogle::Compute
+    def find_vm_by_uuid(uuid)
+      GoogleCompute.new(client: client, zone: zone, identity: uuid.to_s)
+    end
+
+    def new_vm(args = {})
+      vm_args = args.deep_symbolize_keys
+
+      # convert rails nested_attributes into a plain hash
+      volumes_nested_attrs = vm_args.delete(:volumes_attributes)
+      vm_args[:volumes] = nested_attributes_for(:volumes, volumes_nested_attrs) if volumes_nested_attrs
+
+      GoogleCompute.new(client: client, zone: zone, args: vm_args)
+    end
+
+    def destroy_vm(uuid)
+    end
+
+    def create_volumes(args)
+    end
+
+    def create_vm(args = {})
+      new_vm(args)
+      create_volumes(args)
+      # TBD
+    end
+
+    def vm_options(args)
+    end
+
+    def new_volume(attrs = {})
+    end
+
+    def normalize_vm_attrs(vm_attrs)
+    end
+
+    def console(uuid)
+    end
+
+    def associated_host(vm)
+    end
+
+    def available_images(filter: nil)
+      client.images(filter: filter)
+    end
+
+    # ----# Google specific #-----
+
+    def google_project_id
+      client.project_id
+    end
+
+    private
+
+    def client
+      @client ||= ForemanGoogle::GoogleComputeAdapter.new(auth_json_string: password)
+    end
+  end
+end

data/app/models/foreman_google/google_compute.rb

@@ -0,0 +1,127 @@
+module ForemanGoogle
+  class GoogleCompute
+    attr_reader :identity, :name, :hostname, :machine_type, :network_interfaces,
+      :associate_external_ip, :image_id, :disks, :metadata
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def initialize(client:, zone:, identity: nil, args: {})
+      @client = client
+      @zone = zone
+      @identity = identity
+
+      @name = parameterize_name(args[:name])
+      @hostname = @name
+      @machine_type = args[:machine_type]
+      @network_interfaces = construct_network(args[:network] || 'default', args[:associate_external_ip] || '0', args[:network_interfaces] || [])
+      @image_id = args[:image_id]
+      @disks = load_disks(args[:image_id], args[:volumes])
+      @metadata = construct_metadata(args[:user_data])
+
+      identity && load
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    def persisted?
+      !!identity
+    end
+
+    def ready?
+      status == 'RUNNING'
+    end
+
+    def reload
+      return unless identity
+      load
+      self
+    end
+
+    # @returns [String] one of PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED
+    # if nil, instance is not persisted as VM on GCE
+    def status
+      persisted? && instance.status
+    end
+
+    def start
+      raise Foreman::Exception('unable to start machine that is not persisted') unless persisted?
+      @client.start(@zone, identity)
+    end
+
+    def stop
+      raise Foreman::Exception('unable to stop machine that is not persisted') unless persisted?
+      @client.stop(@zone, identity)
+    end
+
+    def to_s
+    end
+
+    def interfaces
+      @network_interfaces
+    end
+
+    def interfaces_attributes=(attrs)
+    end
+
+    def volumes
+      @disks
+    end
+
+    private
+
+    def instance
+      return unless identity
+      @instance || load
+    end
+
+    def load
+      @instance = @client.instance(@zone.split('/').last, identity)
+    end
+
+    def parameterize_name(name)
+      name&.parameterize || "foreman_#{Time.now.to_i}"
+    end
+
+    def construct_network(network_name, associate_external_ip, network_interfaces)
+      # handle network_interface for external ip
+      # assign  ephemeral external IP address using associate_external_ip
+      if ActiveModel::Type::Boolean.new.cast(associate_external_ip)
+        network_interfaces = [{ network: 'global/networks/default' }] if network_interfaces.empty?
+        access_config = { name: 'External NAT', type: 'ONE_TO_ONE_NAT' }
+
+        # Note - no support for external_ip from foreman
+        # access_config[:nat_ip] = external_ip if external_ip
+        network_interfaces[0][:access_configs] = [access_config]
+        return network_interfaces
+      end
+
+      network = "https://compute.googleapis.com/compute/v1/projects/#{@client.project_id}/global/networks/#{network_name}"
+      [{ network: network }]
+    end
+
+    def load_image(image_id)
+      return unless image_id
+
+      image = @client.images.find { |img| img.id == image_id.to_i }
+      raise ::Foreman::Exception, N_('selected image does not exist') if image.nil?
+      image
+    end
+
+    def load_disks(image_id, volumes = [])
+      return [] if volumes.empty?
+      image = load_image(image_id)
+
+      volumes.first[:source_image] = image.name if image
+      # TODO: Is OpenStruct enough to replace Fog::Compute::Google::Disk
+      #       or do we need our own class?
+      volumes.map.with_index do |vol_attrs, i|
+        OpenStruct.new(**vol_attrs.merge(name: "#{@name}-disk#{i + 1}"))
+      end
+    end
+
+    # Note - GCE only supports cloud-init for Container Optimized images and
+    # for custom images with cloud-init setup
+    def construct_metadata(user_data)
+      return if user_data.blank?
+      { items: [{ key: 'user-data', value: user_data }] }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/foreman_google/engine.rb

@@ -0,0 +1,42 @@
+module ForemanGoogle
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanGoogle
+    engine_name 'foreman_google'
+
+    # Add any db migrations
+    initializer 'foreman_google.load_app_instance_data' do |app|
+      ForemanGoogle::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_google.register_plugin', before: :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_google do
+        requires_foreman '>= 2.4.0'
+
+        in_to_prepare do
+          compute_resource(ForemanGoogle::GCE)
+        end
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      ::ComputeResourcesController.include ForemanGoogle::TemporaryPrependPath
+    rescue StandardError => e
+      Rails.logger.warn "ForemanGoogle: skipping engine hook (#{e})"
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanGoogle::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_google.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
+      locale_domain = 'foreman_google'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_google/google_compute_adapter.rb

@@ -0,0 +1,91 @@
+require 'google-cloud-compute'
+
+module ForemanGoogle
+  class GoogleComputeAdapter
+    def initialize(auth_json_string:)
+      @auth_json = JSON.parse(auth_json_string)
+    end
+
+    def project_id
+      @auth_json['project_id']
+    end
+
+    # ------ RESOURCES ------
+
+    # Returns an Google::Instance identified by instance_identity within given zone.
+    # @param zone [String] eighter full url or just zone name
+    # @param instance_identity [String] eighter an instance name or its id
+    def instance(zone, instance_identity)
+      get('instances', instance: instance_identity, zone: zone)
+    end
+
+    def zones
+      list('zones')
+    end
+
+    def networks
+      list('networks')
+    end
+
+    def machine_types(zone)
+      list('machine_types', zone: zone)
+    end
+
+    def start(zone, instance_identity)
+      manage_instance(:start, zone, instance_identity)
+    end
+
+    def stop(zone, instance_identity)
+      manage_instance(:stop, zone, instance_identity)
+    end
+
+    # Setting filter to '(deprecated.state != "DEPRECATED") AND (deprecated.state != "OBSOLETE")'
+    # doesn't work and returns empty array, no idea what is happening there
+    def images(filter: nil)
+      projects = [project_id] + all_projects
+      all_images = projects.map { |project| list_images(project, filter: filter) }
+      all_images.flatten.reject(&:deprecated)
+    end
+
+    private
+
+    def list(resource_name, **opts)
+      response = resource_client(resource_name).list(project: project_id, **opts).response
+      response.items
+    rescue ::Google::Cloud::Error => e
+      raise Foreman::WrappedException.new(e, 'Cannot list Google resource %s', resource_name)
+    end
+
+    def list_images(project, **opts)
+      resource_name = 'images'
+      response = resource_client(resource_name).list(project: project, **opts).response
+      response.items
+    rescue ::Google::Cloud::Error => e
+      raise Foreman::WrappedException.new(e, 'Cannot list Google resource %s', resource_name)
+    end
+
+    def get(resource_name, **opts)
+      resource_client(resource_name).get(project: project_id, **opts)
+    rescue ::Google::Cloud::Error => e
+      raise Foreman::WrappedException.new(e, 'Could not fetch Google resource %s', resource_name)
+    end
+
+    def manage_instance(action, zone, instance_identity)
+      resource_client('instances').send(action, project: project_id, zone: zone, instance: instance_identity)
+    rescue ::Google::Cloud::Error => e
+      raise Foreman::WrappedException.new(e, 'Could not %s Google resource %s', action.to_s, resource_name)
+    end
+
+    def resource_client(resource_name)
+      ::Google::Cloud::Compute.public_send(resource_name) do |config|
+        config.credentials = @auth_json
+      end
+    end
+
+    def all_projects
+      %w[centos-cloud cos-cloud coreos-cloud debian-cloud opensuse-cloud
+         rhel-cloud rhel-sap-cloud suse-cloud suse-sap-cloud
+         ubuntu-os-cloud windows-cloud windows-sql-cloud].freeze
+    end
+  end
+end

data/lib/foreman_google/version.rb

@@ -0,0 +1,3 @@
+module ForemanGoogle
+  VERSION = '0.0.1'.freeze
+end

data/lib/foreman_google.rb

@@ -0,0 +1,4 @@
+require 'foreman_google/engine'
+
+module ForemanGoogle
+end

data/lib/tasks/foreman_google_tasks.rake

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_google do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanGoogle'
+  Rake::TestTask.new(:foreman_google) do |t|
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_google']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_google', 'foreman_google:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = foreman_google
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_google.po

@@ -0,0 +1,19 @@
+# foreman_google
+#
+# This file is distributed under the same license as foreman_google.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_google.pot

@@ -0,0 +1,19 @@
+# foreman_google
+#
+# This file is distributed under the same license as foreman_google.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_google.gemspec
+_('TODO: Description of ForemanGoogle.')

data/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "foreman_google",
+  "version": "1.0.0",
+  "description": "DESCRIPTION",
+  "main": "index.js",
+  "scripts": {
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --config jest.config.js",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "create-react-component": "yo react-domain"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_google.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_google/issues"
+  },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 6.0.0"
+  },
+  "dependencies": {
+    "react-intl": "^2.8.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.7.0",
+    "@sheerun/mutationobserver-shim": "^0.3.3",
+    "@theforeman/builder": "^6.0.0",
+    "@theforeman/eslint-plugin-foreman": "6.0.0",
+    "@theforeman/find-foreman": "^4.8.0",
+    "@theforeman/stories": "^7.0.0",
+    "@theforeman/test": "^8.0.0",
+    "@theforeman/vendor-dev": "^6.0.0",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
+    "prettier": "^1.19.1",
+    "stylelint-config-standard": "^18.0.0",
+    "stylelint": "^9.3.0"
+  }
+}

data/test/factories/gce.rb

@@ -0,0 +1,28 @@
+FactoryBot.modify do
+  factory :compute_resource do
+    trait :google_gce do
+      transient do
+        project_id { 'coastal-haven-123456' }
+      end
+      provider { 'GCE' }
+      password do
+        # instead of private_key, we hand size of new key to generate
+        # this generate valid mocked key, due to overload of OpenSSL::PKey::RSA.new
+        <<-END_AUTHTOKEN
+        {
+          "type": "service_account",
+          "project_id": "#{project_id}",
+          "private_key_id": "7b1afc23bdfd510c49d827f3151fac94b089b42b",
+          "private_key": 2048,
+          "client_email": "xxxxxxx-compute@developer.gserviceaccount.com",
+          "client_id": "111235611116543210000",
+          "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+          "token_uri": "https://oauth2.googleapis.com/token",
+          "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+          "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/552404852006-compute%40developer.gserviceaccount.com"
+        }
+        END_AUTHTOKEN
+      end
+    end
+  end
+end

data/test/fixtures/images_centos_cloud.json

@@ -0,0 +1,11 @@
+{
+  "id": "projects/centos-cloud/global/images",
+  "items": [
+    {
+      "name": "centos-6",
+      "kind": "compute#image"
+    }
+  ],
+  "selfLink": "https://www.googleapis.com/compute/v1/projects/centos-cloud/global/images",
+  "kind": "compute#imageList"
+}