foreman_google 0.0.1

data/test/models/foreman_google/gce_test.rb

@@ -0,0 +1,31 @@
+require 'test_google_helper'
+
+module ForemanGoogle
+  class GCETest < GoogleTestCase
+    subject { ForemanGoogle::GCE.new(zone: 'zone', password: gauth_json) }
+    let(:service) { mock('GoogleAdapter') }
+
+    setup do
+      subject.stubs(client: service)
+      service.stubs(:project_id).returns('project_id')
+    end
+
+    describe '#find_vm_by_uuid' do
+      it 'does query gce' do
+        instance = stub(status: 'RUNNING')
+        service.expects(:instance).with(subject.zone, 'instance_name').returns(instance)
+        compute = subject.find_vm_by_uuid('instance_name')
+        value(compute).must_be_kind_of(ForemanGoogle::GoogleCompute)
+      end
+
+      it 'throws 404 when instance not found on GCE' do
+        service
+          .expects(:instance)
+          .with(subject.zone, 'non-existing-name-or-id')
+          .raises(Foreman::WrappedException.new(Google::Cloud::NotFoundError.new, 'not found'))
+
+        value { subject.find_vm_by_uuid('non-existing-name-or-id') }.must_raise(Foreman::WrappedException)
+      end
+    end
+  end
+end

data/test/models/foreman_google/google_compute_test.rb

@@ -0,0 +1,155 @@
+require 'test_google_helper'
+
+module ForemanGoogle
+  class GoogleComputeTest < GoogleTestCase
+    let(:client) { mock('GoogleAdapter') }
+    let(:zone) { 'zone-1' }
+    let(:identity) { 'instance-id-or-name' }
+
+    subject { ForemanGoogle::GoogleCompute.new(client: client, zone: zone, identity: identity) }
+
+    setup do
+      client.stubs(:project_id).returns('project_id')
+    end
+
+    describe '#reload' do
+      let(:zone) { 'http://test.org/fullurl/zones/zone-1' }
+      let(:zone_name) { zone.split('/').last }
+
+      it 'reloads the instance from gce and returns self' do
+        client.expects(:instance).with(zone_name, identity).twice
+        value(subject.reload).must_equal(subject)
+      end
+    end
+
+    describe '#persisted?' do
+      context 'with identity' do
+        it 'is persisted' do
+          client.stubs(:instance).with(zone, identity)
+          value(subject).must_be(:persisted?)
+        end
+      end
+
+      context 'without identity' do
+        let(:identity) { nil }
+
+        it 'is not persisted' do
+          value(subject).wont_be(:persisted?)
+        end
+      end
+    end
+
+    describe '#ready?' do
+      let(:instance) { mock('Google::Compute::Instance') }
+
+      setup do
+        client.expects(:instance).with(zone, identity).returns(instance)
+      end
+
+      it 'is ready with running instance' do
+        instance.expects(:status).returns('RUNNING')
+        value(subject).must_be(:ready?)
+      end
+
+      it 'is not ready for not running instance' do
+        instance.expects(:status).returns('PROVISIONING')
+        value(subject).wont_be(:ready?)
+      end
+    end
+
+    describe '#name & #hostname' do
+      it 'default value' do
+        args = { network: '' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+
+        assert_includes cr.name, 'foreman_'
+        assert_includes cr.hostname, 'foreman_'
+      end
+
+      it 'is parameterized' do
+        args = { name: 'My new name' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        assert_includes cr.name, 'my-new-name'
+        assert_includes cr.hostname, 'my-new-name'
+      end
+    end
+
+    describe '#network_interfaces' do
+      it 'with default value' do
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone)
+        assert_includes cr.network_interfaces[0][:network], '/projects/project_id/global/networks/default'
+      end
+
+      it 'with custom value' do
+        args = { network: 'custom' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        assert_includes cr.network_interfaces[0][:network], '/projects/project_id/global/networks/custom'
+      end
+
+      it 'with associated external ip' do
+        args = { associate_external_ip: '1' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        expected_nics = [{ network: 'global/networks/default', access_configs: [{ name: 'External NAT', type: 'ONE_TO_ONE_NAT' }] }]
+
+        assert_equal cr.network_interfaces, expected_nics
+      end
+
+      it 'with nics' do
+        nics = [{ network: 'global/networks/custom' }]
+        args = { associate_external_ip: '1', network_interfaces: nics }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        expected_nics = [{ network: 'global/networks/custom', access_configs: [{ name: 'External NAT', type: 'ONE_TO_ONE_NAT' }] }]
+
+        assert_equal cr.network_interfaces, expected_nics
+      end
+    end
+
+    describe '#disks' do
+      setup do
+        client.stubs(:images).returns([OpenStruct.new(id: 1, name: 'coastal-image')])
+      end
+
+      it 'no volumes' do
+        args = { volumes: [] }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+
+        assert_equal cr.disks, []
+      end
+
+      it 'without image_id' do
+        args = { volumes: [{ size_gb: '23' }] }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        disk = cr.disks.first
+
+        assert_equal disk.name, "#{cr.name}-disk1"
+        assert_nil disk.source_image
+      end
+
+      it 'image not found' do
+        args = { volumes: [{ size_gb: '23' }], image_id: '0' }
+        value { ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args) }.must_raise(::Foreman::Exception)
+      end
+
+      it 'with source_image' do
+        args = { volumes: [{ size_gb: '23', source_image: 'centos-stream-8-v20220317' }], image_id: '1' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+
+        disk = cr.disks.first
+        assert_equal disk.source_image, 'coastal-image'
+      end
+    end
+
+    describe '#metadata' do
+      it 'with user_data' do
+        args = { user_data: 'test' }
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone, args: args)
+        assert_equal cr.metadata, { items: [{ key: 'user-data', value: 'test' }] }
+      end
+
+      it 'no user_data' do
+        cr = ForemanGoogle::GoogleCompute.new(client: client, zone: zone)
+        assert_nil cr.metadata
+      end
+    end
+  end
+end

data/test/test_google_helper.rb

@@ -0,0 +1,24 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload
+
+if ENV['VCR'] == '1'
+  VCR.configure do |c|
+    c.cassette_library_dir = ForemanGoogle::Engine.root.join('test', 'fixtures')
+    c.hook_into :webmock
+  end
+end
+
+class GoogleTestCase < ActiveSupport::TestCase
+  let(:google_access_token) { 'ya29.c.stubbed_token' }
+  let(:gce_cr) { FactoryBot.create(:compute_resource, :google_gce) }
+  let(:google_project_id) { gce_cr.google_project_id }
+  let(:gauth_json) { (ENV['VCR'] == '1' ? ENV['GCE_AUTH'] : nil) || gce_cr.password }
+
+  setup do
+    ::Signet::OAuth2::Client.any_instance.stubs(fetch_access_token!: google_access_token) unless ENV['VCR'] == '1'
+  end
+end

data/test/unit/foreman_google/google_compute_adapter_test.rb

@@ -0,0 +1,126 @@
+require 'test_google_helper'
+require 'foreman_google/google_compute_adapter'
+
+require 'google/cloud/compute/v1/zones/credentials'
+module ForemanGoogle
+  class GoogleComputeAdapterTest < GoogleTestCase
+    subject { ForemanGoogle::GoogleComputeAdapter.new(auth_json_string: gauth_json) }
+
+    describe 'authentication' do
+      it 'passes the auth json to the service client' do
+        credentials = stub(client: stub(apply: { authorization: "Bearer #{google_access_token}" }))
+        ::Google::Cloud::Compute::V1::Zones::Credentials.expects(:new).with(JSON.parse(gauth_json), has_key(:scope)).returns(credentials)
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones')
+          .to_return(body: '{
+            "id": "projects/coastal-haven-123456/zones",
+            "items": [],
+            "selfLink": "https://www.googleapis.com/compute/v1/projects/coastal-haven-123456/zones",
+            "kind": "compute#zoneList"
+          }')
+        subject.zones
+      end
+    end
+
+    describe '#instance' do
+      setup do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones/us-east1-b/instances/instance-1')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'instance.json')))
+      end
+
+      it 'gets instance by id' do
+        instance = subject.instance('us-east1-b', 'instance-1')
+        value(instance).must_be_kind_of(Google::Cloud::Compute::V1::Instance)
+        value(instance.id).must_equal(123_456_789)
+      end
+    end
+
+    describe '#zones' do
+      setup do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'zones.json')))
+      end
+
+      it 'show zones' do
+        zones = subject.zones
+        value(zones.first.name).must_be_kind_of(String)
+        value(zones.first.description).must_be_kind_of(String)
+      end
+    end
+
+    describe '#networks' do
+      setup do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/global/networks')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'networks.json')))
+      end
+
+      it 'show networks' do
+        assert_equal ['default'], subject.networks.map(&:name)
+      end
+    end
+
+    describe '#machine_types' do
+      setup do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones/us-east1-b/machineTypes')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'machine_types.json')))
+      end
+
+      it 'list machine_types' do
+        assert_equal ['machine_type_001'], subject.machine_types('us-east1-b').map(&:name)
+      end
+    end
+
+    describe '#images' do
+      setup do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/global/images')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'images_coastal.json')))
+      end
+
+      it 'list images' do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/centos-cloud/global/images')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'images_centos_cloud.json')))
+
+        subject.stub(:all_projects, %w[centos-cloud]) do
+          assert_equal %w[coastal-image centos-6], subject.images.map(&:name)
+        end
+      end
+
+      it 'list images with filter' do
+        not_found_body = File.read(File.join(__dir__, '..', '..', 'fixtures', 'images_nothing_found.json'))
+        %w[coastal-haven-123456 centos-cloud].each do |project|
+          url = "https://compute.googleapis.com/compute/v1/projects/#{project}/global/images?filter=name%20=%20%22NOTHING_FOUND%22"
+          stub_request(:get, url).to_return(body: not_found_body)
+        end
+
+        subject.stub(:all_projects, %w[centos-cloud]) do
+          assert_empty subject.images(filter: 'name = "NOTHING_FOUND"')
+        end
+      end
+
+      it 'ignore deprecated images' do
+        stub_request(:get, 'https://compute.googleapis.com/compute/v1/projects/deprecated/global/images')
+          .to_return(body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'images_deprecated.json')))
+
+        subject.stub(:all_projects, %w[deprecated]) do
+          assert_equal ['coastal-image'], subject.images.map(&:name)
+        end
+      end
+    end
+
+    describe 'manage vm' do
+      it '#start' do
+        stub_request(:post, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones/us-east1-b/instances/instance_name/start')
+          .to_return(status: 200, body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'instance_start.json')), headers: {})
+        result = subject.start('us-east1-b', 'instance_name')
+        assert 'start', result.operation.operation_type
+      end
+
+      it '#stop' do
+        stub_request(:post, 'https://compute.googleapis.com/compute/v1/projects/coastal-haven-123456/zones/us-east1-b/instances/instance_name/stop').
+
+          to_return(status: 200, body: File.read(File.join(__dir__, '..', '..', 'fixtures', 'instance_stop.json')), headers: {})
+        result = subject.stop('us-east1-b', 'instance_name')
+        assert 'stop', result.operation.operation_type
+      end
+    end
+  end
+end

data/webpack/global_index.js

@@ -0,0 +1,17 @@
+import { registerReducer } from 'foremanReact/common/MountingService';
+// import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import Routes from './src/Router/routes';
+import reducers from './src/reducers';
+
+// register reducers
+Object.entries(reducers).forEach(([key, reducer]) =>
+  registerReducer(key, reducer)
+);
+
+// register client routes
+registerRoutes('ForemanGoogle', Routes);
+
+// register fills for extending foreman core
+// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
+// addGlobalFill('<slotId>', '<fillId>', <div key='plugin-template-example' />, 300);

data/webpack/global_test_setup.js

@@ -0,0 +1,11 @@
+// runs before each test to make sure console.error output will
+// fail a test (i.e. default PropType missing). Check the error
+// output and traceback for actual error.
+global.console.error = (error, stack) => {
+  /* eslint-disable-next-line no-console */
+  if (stack) console.log(stack); // Prints out original stack trace
+  throw new Error(error);
+};
+
+// Increase jest timeout as some tests using multiple http mocks can time out on CI systems.
+jest.setTimeout(10000);

data/webpack/index.js

@@ -0,0 +1,7 @@
+import componentRegistry from 'foremanReact/components/componentRegistry';
+
+// register components for erb mounting
+componentRegistry.register({
+  // name: 'Component',
+  // type: Component,
+});

data/webpack/src/Extends/index.js

@@ -0,0 +1,15 @@
+// This is an example of extending foreman-core's component via slot&fill
+// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
+/*
+import React from 'react';
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+
+addGlobalFill('slotId', 'fillId', <SomeComponent key="some-key" />, 300);
+
+addGlobalFill(
+  'slotId',
+  'fillId',
+  { someProp: 'this is an override prop' },
+  300
+);
+*/

data/webpack/src/Router/routes.js

@@ -0,0 +1,5 @@
+// import React from 'react';
+
+const routes = [];
+
+export default routes;

data/webpack/src/reducers.js

@@ -0,0 +1,7 @@
+import { combineReducers } from 'redux';
+
+const reducers = {
+  ForemanGoogle: combineReducers({}),
+};
+
+export default reducers;

data/webpack/test_setup.js

@@ -0,0 +1,17 @@
+import 'core-js/shim';
+import 'regenerator-runtime/runtime';
+import MutationObserver from '@sheerun/mutationobserver-shim';
+
+import { configure } from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+
+configure({ adapter: new Adapter() });
+
+// Mocking translation function
+global.__ = text => text; // eslint-disable-line
+
+// Mocking locales to prevent unnecessary fallback messages
+window.locales = { en: { domain: 'app', locale_data: { app: { '': {} } } } };
+
+// see https://github.com/testing-library/dom-testing-library/releases/tag/v7.0.0
+window.MutationObserver = MutationObserver;

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: foreman_google
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- The Foreman Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-compute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Compute Engine plugin for the Foreman
+email:
+- dev@community.theforeman.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/foreman_google/temporary_prepend_path.rb
+- app/models/foreman_google/gce.rb
+- app/models/foreman_google/google_compute.rb
+- config/routes.rb
+- lib/foreman_google.rb
+- lib/foreman_google/engine.rb
+- lib/foreman_google/google_compute_adapter.rb
+- lib/foreman_google/version.rb
+- lib/tasks/foreman_google_tasks.rake
+- locale/Makefile
+- locale/en/foreman_google.po
+- locale/foreman_google.pot
+- locale/gemspec.rb
+- package.json
+- test/factories/gce.rb
+- test/fixtures/images_centos_cloud.json
+- test/fixtures/images_coastal.json
+- test/fixtures/images_deprecated.json
+- test/fixtures/images_nothing_found.json
+- test/fixtures/instance.json
+- test/fixtures/instance_start.json
+- test/fixtures/instance_stop.json
+- test/fixtures/machine_types.json
+- test/fixtures/networks.json
+- test/fixtures/zones.json
+- test/models/foreman_google/gce_test.rb
+- test/models/foreman_google/google_compute_test.rb
+- test/test_google_helper.rb
+- test/unit/foreman_google/google_compute_adapter_test.rb
+- webpack/global_index.js
+- webpack/global_test_setup.js
+- webpack/index.js
+- webpack/src/Extends/index.js
+- webpack/src/Router/routes.js
+- webpack/src/reducers.js
+- webpack/test_setup.js
+homepage: https://github.com/theforeman/foreman_google
+licenses:
+- GPL-3.0
+metadata:
+  is_foreman_plugin: 'true'
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Google Compute Engine plugin for the Foreman
+test_files:
+- test/models/foreman_google/google_compute_test.rb
+- test/models/foreman_google/gce_test.rb
+- test/unit/foreman_google/google_compute_adapter_test.rb
+- test/factories/gce.rb
+- test/fixtures/networks.json
+- test/fixtures/instance.json
+- test/fixtures/zones.json
+- test/fixtures/instance_stop.json
+- test/fixtures/machine_types.json
+- test/fixtures/images_coastal.json
+- test/fixtures/instance_start.json
+- test/fixtures/images_deprecated.json
+- test/fixtures/images_centos_cloud.json
+- test/fixtures/images_nothing_found.json
+- test/test_google_helper.rb