Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Teams - key-pair management #170

Merged
merged 1 commit into from
Feb 19, 2024
Merged

Teams - key-pair management #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions app/controllers/key_pairs_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
class KeyPairsController < ApplicationController
before_action :set_project_id, except: :new

def new
authorize! :create, KeyPair
@user = current_user
@key_pair = KeyPair.new(user: @user)
authorize! :create, @key_pair
@cloud_service_config = CloudServiceConfig.first
if @cloud_service_config.nil?
flash[:alert] = "Unable to create key-pairs: cloud environment config not set"
redirect_to root_path
return
end
@key_pair = KeyPair.new(user: @user)
end

def index
Expand All @@ -19,20 +20,18 @@ def index
return
end

unless current_user.project_id
flash[:alert] = "Unable to check key-pairs: you do not yet have a project id. " \
"This will be added automatically shortly."
unless @project_id
flash[:alert] = "Unable to check key-pairs: you must belong to a team with a project id."
redirect_to edit_user_registration_path
return
end

result = GetUserKeyPairsJob.perform_now(@cloud_service_config, current_user)
result = GetUserKeyPairsJob.perform_now(@cloud_service_config, current_user, @project_id)
if result.success?
@key_pairs = result.key_pairs
else
flash[:alert] = "Unable to get key-pairs: #{result.error_message}"
redirect_to edit_user_registration_path
return
end
end

Expand All @@ -50,14 +49,13 @@ def create
return
end

unless current_user.project_id
flash[:alert] = "Unable to send key-pair request: you do not yet have a project id. " \
"This will be added automatically shortly."
unless @project_id
flash[:alert] = "Unable to create key-pair: you must belong to a team with a project id."
redirect_to edit_user_registration_path
return
end

result = CreateKeyPairJob.perform_now(@key_pair, @cloud_service_config, current_user)
result = CreateKeyPairJob.perform_now(@key_pair, @cloud_service_config, current_user, @project_id)

if result.success?
render action: :success
Expand All @@ -77,14 +75,13 @@ def destroy
return
end

unless current_user.project_id
flash[:alert] = "Unable to send key-pair deletion request: you do not yet have a project id. " \
"This will be added automatically shortly."
unless @project_id
flash[:alert] = "Unable to send key-pair deletion request: you must belong to a team with a project id."
redirect_to edit_user_registration_path
return
end

result = DeleteKeyPairJob.perform_now(params[:name], @cloud_service_config, current_user)
result = DeleteKeyPairJob.perform_now(params[:name], @cloud_service_config, current_user, @project_id)

if result.success?
flash[:success] = "Key-pair '#{params[:name]}' deleted"
Expand All @@ -100,4 +97,10 @@ def destroy
def key_pair_params
params.require(:key_pair).permit(*PERMITTED_PARAMS)
end

# key pairs are user (not project) specific, but membership of a project is required
Copy link
Contributor Author

@timalces timalces Feb 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is intended that in the future users will have a personal team created during sign up. That can then be used for the below.

# to view, create and delete them
def set_project_id
@project_id = current_user.teams.where.not(project_id: nil).first&.project_id
end
end
8 changes: 5 additions & 3 deletions app/jobs/create_key_pair_job.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
class CreateKeyPairJob < ApplicationJob
queue_as :default

def perform(key_pair, cloud_service_config, user, **options)
def perform(key_pair, cloud_service_config, user, project_id, **options)
runner = Runner.new(
key_pair: key_pair,
user: user,
project_id: project_id,
cloud_service_config: cloud_service_config,
logger: logger,
**options
Expand All @@ -32,9 +33,10 @@ def error_message
end

class Runner < HttpRequests::Faraday::JobRunner
def initialize(key_pair:, user:, **kwargs)
def initialize(key_pair:, user:, project_id:, **kwargs)
@key_pair = key_pair
@user = user
@project_id = project_id
super(**kwargs)
end

Expand Down Expand Up @@ -93,7 +95,7 @@ def cloud_env_details
auth_url: @cloud_service_config.internal_auth_url,
user_id: @user.cloud_user_id,
password: @user.foreign_password,
project_id: @user.project_id
project_id: @project_id
}
end
end
Expand Down
8 changes: 5 additions & 3 deletions app/jobs/delete_key_pair_job.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
class DeleteKeyPairJob < ApplicationJob
queue_as :default

def perform(key_pair_name, cloud_service_config, user, **options)
def perform(key_pair_name, cloud_service_config, user, project_id, **options)
runner = Runner.new(
key_pair_name: key_pair_name,
user: user,
project_id: project_id,
cloud_service_config: cloud_service_config,
logger: logger,
**options
Expand All @@ -32,9 +33,10 @@ def error_message
end

class Runner < HttpRequests::Faraday::JobRunner
def initialize(key_pair_name:, user:, **kwargs)
def initialize(key_pair_name:, user:, project_id:, **kwargs)
@key_pair_name = key_pair_name
@user = user
@project_id = project_id
super(**kwargs)
end

Expand Down Expand Up @@ -81,7 +83,7 @@ def cloud_env_details
auth_url: @cloud_service_config.internal_auth_url,
user_id: @user.cloud_user_id,
password: @user.foreign_password,
project_id: @user.project_id
project_id: @project_id
}
end
end
Expand Down
8 changes: 5 additions & 3 deletions app/jobs/get_user_key_pairs_job.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
class GetUserKeyPairsJob < ApplicationJob
queue_as :default

def perform(cloud_service_config, user, **options)
def perform(cloud_service_config, user, project_id, **options)
runner = Runner.new(
user: user,
project_id: project_id,
cloud_service_config: cloud_service_config,
logger: logger,
**options
Expand Down Expand Up @@ -33,8 +34,9 @@ def error_message
end

class Runner < HttpRequests::Faraday::JobRunner
def initialize(user:, **kwargs)
def initialize(user:, project_id:, **kwargs)
@user = user
@project_id = project_id
super(**kwargs)
end

Expand Down Expand Up @@ -74,7 +76,7 @@ def body
auth_url: @cloud_service_config.internal_auth_url,
user_id: @user.cloud_user_id,
password: @user.foreign_password,
project_id: @user.project_id
project_id: @project_id
}
}
end
Expand Down
21 changes: 11 additions & 10 deletions spec/jobs/create_key_pair_job_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
let(:stubs) { Faraday::Adapter::Test::Stubs.new }
let(:cloud_service_config) { create(:cloud_service_config) }
let(:user) { create(:user, :with_openstack_account) }
let(:project_id) { Faker::Alphanumeric.alphanumeric(number: 10) }
let(:path) { "#{cloud_service_config.user_handler_base_url}/key_pairs" }
let(:key_pair) { build(:key_pair, user: user) }
subject { CreateKeyPairJob::Runner.new(key_pair: key_pair, cloud_service_config: cloud_service_config, user: user) }
subject { CreateKeyPairJob::Runner.new(key_pair: key_pair, cloud_service_config: cloud_service_config, user: user, project_id: project_id) }

describe "url" do
before(:each) do
Expand All @@ -32,12 +33,12 @@ class << subject
end

it "returns a successful result" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).to be_success
end

it 'populates private key' do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(key_pair.private_key).to eq "abc"
end
end
Expand All @@ -48,12 +49,12 @@ class << subject
end

it "returns an unsuccessful result" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(result.error_message).to eq "the server responded with status 404"
end
end
Expand All @@ -65,12 +66,12 @@ class << subject
end

it "returns an unsuccessful result" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs)
expect(result.error_message).to eq "Key pair with that name already exists"
end
end
Expand All @@ -82,12 +83,12 @@ class << subject
let(:timeout) { 0.1 }

it "returns an unsuccessful result" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs, timeout: timeout)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs, timeout: timeout)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now(key_pair, cloud_service_config, user, test_stubs: stubs, timeout: timeout)
result = described_class.perform_now(key_pair, cloud_service_config, user, project_id, test_stubs: stubs, timeout: timeout)
expect(result.error_message).to eq "execution expired"
end
end
Expand All @@ -109,7 +110,7 @@ class << subject
"auth_url" => cloud_service_config.internal_auth_url,
"user_id" => user.cloud_user_id,
"password" => user.foreign_password,
"project_id" => user.project_id
"project_id" => project_id
})
end
end
Expand Down
22 changes: 13 additions & 9 deletions spec/jobs/delete_key_pair_job_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
let(:stubs) { Faraday::Adapter::Test::Stubs.new }
let(:cloud_service_config) { create(:cloud_service_config) }
let(:user) { create(:user, :with_openstack_account) }
let(:project_id) { Faker::Alphanumeric.alphanumeric(number: 10) }
let(:path) { "#{cloud_service_config.user_handler_base_url}/key_pairs" }
subject { DeleteKeyPairJob::Runner.new(key_pair_name: "my_lovely_key_pair", cloud_service_config: cloud_service_config, user: user) }
subject do
DeleteKeyPairJob::Runner.new(key_pair_name: "my_lovely_key_pair", cloud_service_config: cloud_service_config,
user: user, project_id: project_id)
end

describe "url" do
before(:each) do
Expand All @@ -31,7 +35,7 @@ class << subject
end

it "returns a successful result" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).to be_success
end
end
Expand All @@ -42,12 +46,12 @@ class << subject
end

it "returns an unsuccessful result" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs)
expect(result.error_message).to eq "the server responded with status 404"
end
end
Expand All @@ -59,12 +63,12 @@ class << subject
end

it "returns an unsuccessful result" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs)
expect(result.error_message).to eq "Something happened"
end
end
Expand All @@ -76,12 +80,12 @@ class << subject
let(:timeout) { 0.1 }

it "returns an unsuccessful result" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs, timeout: timeout)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs, timeout: timeout)
expect(result).not_to be_success
end

it "returns a sensible error_message" do
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, test_stubs: stubs, timeout: timeout)
result = described_class.perform_now("my_lovely_key_pair", cloud_service_config, user, project_id, test_stubs: stubs, timeout: timeout)
expect(result.error_message).to eq "execution expired"
end
end
Expand All @@ -99,7 +103,7 @@ class << subject
"auth_url" => cloud_service_config.internal_auth_url,
"user_id" => user.cloud_user_id,
"password" => user.foreign_password,
"project_id" => user.project_id
"project_id" => project_id
})
end
end
Expand Down