diff options
author | Sean McGivern <sean@gitlab.com> | 2019-06-17 17:55:05 +0300 |
---|---|---|
committer | Sean McGivern <sean@gitlab.com> | 2019-06-17 17:55:05 +0300 |
commit | cfcdfdd2de6009e7ce55e6a415825a0eca75f0c9 (patch) | |
tree | 6c79878d6d451133d6365ead0acf6e8c5eb4c778 | |
parent | 52e2a73641577386451b6e9007a15a3dfff25df2 (diff) | |
parent | 1f332ae8da994509232c7601074b25514ad23c52 (diff) |
Merge branch '58886-issue-tracker-fields' into 'master'
Create models for issue trackers data
See merge request gitlab-org/gitlab-ce!28598
-rw-r--r-- | app/models/project_services/data_fields.rb | 10 | ||||
-rw-r--r-- | app/models/project_services/issue_tracker_data.rb | 25 | ||||
-rw-r--r-- | app/models/project_services/jira_tracker_data.rb | 30 | ||||
-rw-r--r-- | app/models/service.rb | 1 | ||||
-rw-r--r-- | db/migrate/20190430131225_create_issue_tracker_data.rb | 23 | ||||
-rw-r--r-- | db/migrate/20190430142025_create_jira_tracker_data.rb | 26 | ||||
-rw-r--r-- | db/schema.rb | 31 | ||||
-rw-r--r-- | spec/db/schema_spec.rb | 1 | ||||
-rw-r--r-- | spec/factories/services_data.rb | 18 | ||||
-rw-r--r-- | spec/lib/gitlab/import_export/all_models.yml | 2 | ||||
-rw-r--r-- | spec/models/project_services/issue_tracker_data_spec.rb | 35 | ||||
-rw-r--r-- | spec/models/project_services/jira_tracker_data_spec.rb | 42 | ||||
-rw-r--r-- | spec/models/service_spec.rb | 2 |
13 files changed, 246 insertions, 0 deletions
diff --git a/app/models/project_services/data_fields.rb b/app/models/project_services/data_fields.rb new file mode 100644 index 00000000000..438d85098c8 --- /dev/null +++ b/app/models/project_services/data_fields.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module DataFields + extend ActiveSupport::Concern + + included do + has_one :issue_tracker_data + has_one :jira_tracker_data + end +end diff --git a/app/models/project_services/issue_tracker_data.rb b/app/models/project_services/issue_tracker_data.rb new file mode 100644 index 00000000000..2c1d28ed421 --- /dev/null +++ b/app/models/project_services/issue_tracker_data.rb @@ -0,0 +1,25 @@ +# frozen_string_literal: true + +class IssueTrackerData < ApplicationRecord + belongs_to :service + + delegate :activated?, to: :service, allow_nil: true + + validates :service, presence: true + validates :project_url, presence: true, public_url: { enforce_sanitization: true }, if: :activated? + validates :issues_url, presence: true, public_url: { enforce_sanitization: true }, if: :activated? + validates :new_issue_url, public_url: { enforce_sanitization: true }, if: :activated? + + def self.encryption_options + { + key: Settings.attr_encrypted_db_key_base_32, + encode: true, + mode: :per_attribute_iv, + algorithm: 'aes-256-gcm' + } + end + + attr_encrypted :project_url, encryption_options + attr_encrypted :issues_url, encryption_options + attr_encrypted :new_issue_url, encryption_options +end diff --git a/app/models/project_services/jira_tracker_data.rb b/app/models/project_services/jira_tracker_data.rb new file mode 100644 index 00000000000..4f528e3d81b --- /dev/null +++ b/app/models/project_services/jira_tracker_data.rb @@ -0,0 +1,30 @@ +# frozen_string_literal: true + +class JiraTrackerData < ApplicationRecord + belongs_to :service + + delegate :activated?, to: :service, allow_nil: true + + validates :service, presence: true + validates :url, public_url: { enforce_sanitization: true }, presence: true, if: :activated? + validates :api_url, public_url: { enforce_sanitization: true }, allow_blank: true + validates :username, presence: true, if: :activated? + validates :password, presence: true, if: :activated? + validates :jira_issue_transition_id, + format: { with: Gitlab::Regex.jira_transition_id_regex, message: s_("JiraService|transition ids can have only numbers which can be split with , or ;") }, + allow_blank: true + + def self.encryption_options + { + key: Settings.attr_encrypted_db_key_base_32, + encode: true, + mode: :per_attribute_iv, + algorithm: 'aes-256-gcm' + } + end + + attr_encrypted :url, encryption_options + attr_encrypted :api_url, encryption_options + attr_encrypted :username, encryption_options + attr_encrypted :password, encryption_options +end diff --git a/app/models/service.rb b/app/models/service.rb index 9896aa12e90..16fbe6648cc 100644 --- a/app/models/service.rb +++ b/app/models/service.rb @@ -6,6 +6,7 @@ class Service < ApplicationRecord include Sortable include Importable include ProjectServicesLoggable + include DataFields serialize :properties, JSON # rubocop:disable Cop/ActiveRecordSerialize diff --git a/db/migrate/20190430131225_create_issue_tracker_data.rb b/db/migrate/20190430131225_create_issue_tracker_data.rb new file mode 100644 index 00000000000..7859bea9c22 --- /dev/null +++ b/db/migrate/20190430131225_create_issue_tracker_data.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +# See http://doc.gitlab.com/ce/development/migration_style_guide.html +# for more information on how to write migrations for GitLab. + +class CreateIssueTrackerData < ActiveRecord::Migration[5.1] + include Gitlab::Database::MigrationHelpers + + DOWNTIME = false + + def change + create_table :issue_tracker_data do |t| + t.references :service, foreign_key: { on_delete: :cascade }, type: :integer, index: true, null: false + t.timestamps_with_timezone + t.string :encrypted_project_url + t.string :encrypted_project_url_iv + t.string :encrypted_issues_url + t.string :encrypted_issues_url_iv + t.string :encrypted_new_issue_url + t.string :encrypted_new_issue_url_iv + end + end +end diff --git a/db/migrate/20190430142025_create_jira_tracker_data.rb b/db/migrate/20190430142025_create_jira_tracker_data.rb new file mode 100644 index 00000000000..d328ad63854 --- /dev/null +++ b/db/migrate/20190430142025_create_jira_tracker_data.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +# See http://doc.gitlab.com/ce/development/migration_style_guide.html +# for more information on how to write migrations for GitLab. + +class CreateJiraTrackerData < ActiveRecord::Migration[5.1] + include Gitlab::Database::MigrationHelpers + + DOWNTIME = false + + def change + create_table :jira_tracker_data do |t| + t.references :service, foreign_key: { on_delete: :cascade }, type: :integer, index: true, null: false + t.timestamps_with_timezone + t.string :encrypted_url + t.string :encrypted_url_iv + t.string :encrypted_api_url + t.string :encrypted_api_url_iv + t.string :encrypted_username + t.string :encrypted_username_iv + t.string :encrypted_password + t.string :encrypted_password_iv + t.string :jira_issue_transition_id + end + end +end diff --git a/db/schema.rb b/db/schema.rb index 01a00103dd5..db1ef81ede6 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -1068,6 +1068,19 @@ ActiveRecord::Schema.define(version: 20190611161641) do t.index ["issue_id"], name: "index_issue_metrics", using: :btree end + create_table "issue_tracker_data", force: :cascade do |t| + t.integer "service_id", null: false + t.datetime_with_timezone "created_at", null: false + t.datetime_with_timezone "updated_at", null: false + t.string "encrypted_project_url" + t.string "encrypted_project_url_iv" + t.string "encrypted_issues_url" + t.string "encrypted_issues_url_iv" + t.string "encrypted_new_issue_url" + t.string "encrypted_new_issue_url_iv" + t.index ["service_id"], name: "index_issue_tracker_data_on_service_id", using: :btree + end + create_table "issues", id: :serial, force: :cascade do |t| t.string "title" t.integer "author_id" @@ -1111,6 +1124,22 @@ ActiveRecord::Schema.define(version: 20190611161641) do t.index ["updated_by_id"], name: "index_issues_on_updated_by_id", where: "(updated_by_id IS NOT NULL)", using: :btree end + create_table "jira_tracker_data", force: :cascade do |t| + t.integer "service_id", null: false + t.datetime_with_timezone "created_at", null: false + t.datetime_with_timezone "updated_at", null: false + t.string "encrypted_url" + t.string "encrypted_url_iv" + t.string "encrypted_api_url" + t.string "encrypted_api_url_iv" + t.string "encrypted_username" + t.string "encrypted_username_iv" + t.string "encrypted_password" + t.string "encrypted_password_iv" + t.string "jira_issue_transition_id" + t.index ["service_id"], name: "index_jira_tracker_data_on_service_id", using: :btree + end + create_table "keys", id: :serial, force: :cascade do |t| t.integer "user_id" t.datetime "created_at" @@ -2539,12 +2568,14 @@ ActiveRecord::Schema.define(version: 20190611161641) do add_foreign_key "issue_assignees", "issues", name: "fk_b7d881734a", on_delete: :cascade add_foreign_key "issue_assignees", "users", name: "fk_5e0c8d9154", on_delete: :cascade add_foreign_key "issue_metrics", "issues", on_delete: :cascade + add_foreign_key "issue_tracker_data", "services", on_delete: :cascade add_foreign_key "issues", "issues", column: "moved_to_id", name: "fk_a194299be1", on_delete: :nullify add_foreign_key "issues", "milestones", name: "fk_96b1dd429c", on_delete: :nullify add_foreign_key "issues", "projects", name: "fk_899c8f3231", on_delete: :cascade add_foreign_key "issues", "users", column: "author_id", name: "fk_05f1e72feb", on_delete: :nullify add_foreign_key "issues", "users", column: "closed_by_id", name: "fk_c63cbf6c25", on_delete: :nullify add_foreign_key "issues", "users", column: "updated_by_id", name: "fk_ffed080f01", on_delete: :nullify + add_foreign_key "jira_tracker_data", "services", on_delete: :cascade add_foreign_key "label_links", "labels", name: "fk_d97dd08678", on_delete: :cascade add_foreign_key "label_priorities", "labels", on_delete: :cascade add_foreign_key "label_priorities", "projects", on_delete: :cascade diff --git a/spec/db/schema_spec.rb b/spec/db/schema_spec.rb index 40c3a6d90d0..33254d607c9 100644 --- a/spec/db/schema_spec.rb +++ b/spec/db/schema_spec.rb @@ -26,6 +26,7 @@ describe 'Database schema' do forked_project_links: %w[forked_from_project_id], identities: %w[user_id], issues: %w[last_edited_by_id state_id], + jira_tracker_data: %w[jira_issue_transition_id], keys: %w[user_id], label_links: %w[target_id], lfs_objects_projects: %w[lfs_object_id project_id], diff --git a/spec/factories/services_data.rb b/spec/factories/services_data.rb new file mode 100644 index 00000000000..387e130a743 --- /dev/null +++ b/spec/factories/services_data.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +FactoryBot.define do + factory :jira_tracker_data do + service + url 'http://jira.example.com' + api_url 'http://api-jira.example.com' + username 'jira_username' + password 'jira_password' + end + + factory :issue_tracker_data do + service + project_url 'http://issuetracker.example.com' + issues_url 'http://issues.example.com' + new_issue_url 'http://new-issue.example.com' + end +end diff --git a/spec/lib/gitlab/import_export/all_models.yml b/spec/lib/gitlab/import_export/all_models.yml index 2242543daad..002359e5cc0 100644 --- a/spec/lib/gitlab/import_export/all_models.yml +++ b/spec/lib/gitlab/import_export/all_models.yml @@ -175,6 +175,8 @@ deploy_keys: services: - project - service_hook +- jira_tracker_data +- issue_tracker_data hooks: - project - web_hook_logs diff --git a/spec/models/project_services/issue_tracker_data_spec.rb b/spec/models/project_services/issue_tracker_data_spec.rb new file mode 100644 index 00000000000..aaab654f874 --- /dev/null +++ b/spec/models/project_services/issue_tracker_data_spec.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe IssueTrackerData do + let(:service) { create(:custom_issue_tracker_service, active: false, properties: {}) } + + describe 'Associations' do + it { is_expected.to belong_to :service } + end + + describe 'Validations' do + subject { described_class.new(service: service) } + + context 'url validations' do + context 'when service is inactive' do + it { is_expected.not_to validate_presence_of(:project_url) } + it { is_expected.not_to validate_presence_of(:issues_url) } + end + + context 'when service is active' do + before do + service.update(active: true) + end + + it_behaves_like 'issue tracker service URL attribute', :project_url + it_behaves_like 'issue tracker service URL attribute', :issues_url + it_behaves_like 'issue tracker service URL attribute', :new_issue_url + + it { is_expected.to validate_presence_of(:project_url) } + it { is_expected.to validate_presence_of(:issues_url) } + end + end + end +end diff --git a/spec/models/project_services/jira_tracker_data_spec.rb b/spec/models/project_services/jira_tracker_data_spec.rb new file mode 100644 index 00000000000..1b6ece8531b --- /dev/null +++ b/spec/models/project_services/jira_tracker_data_spec.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe JiraTrackerData do + let(:service) { create(:jira_service, active: false, properties: {}) } + + describe 'Associations' do + it { is_expected.to belong_to(:service) } + end + + describe 'Validations' do + subject { described_class.new(service: service) } + + context 'jira_issue_transition_id' do + it { is_expected.to allow_value(nil).for(:jira_issue_transition_id) } + it { is_expected.to allow_value('1,2,3').for(:jira_issue_transition_id) } + it { is_expected.to allow_value('1;2;3').for(:jira_issue_transition_id) } + it { is_expected.not_to allow_value('a,b,cd').for(:jira_issue_transition_id) } + end + + context 'url validations' do + context 'when service is inactive' do + it { is_expected.not_to validate_presence_of(:url) } + it { is_expected.not_to validate_presence_of(:username) } + it { is_expected.not_to validate_presence_of(:password) } + end + + context 'when service is active' do + before do + service.update(active: true) + end + + it_behaves_like 'issue tracker service URL attribute', :url + + it { is_expected.to validate_presence_of(:url) } + it { is_expected.to validate_presence_of(:username) } + it { is_expected.to validate_presence_of(:password) } + end + end + end +end diff --git a/spec/models/service_spec.rb b/spec/models/service_spec.rb index 64db32781fe..c9439b0846d 100644 --- a/spec/models/service_spec.rb +++ b/spec/models/service_spec.rb @@ -6,6 +6,8 @@ describe Service do describe "Associations" do it { is_expected.to belong_to :project } it { is_expected.to have_one :service_hook } + it { is_expected.to have_one :jira_tracker_data } + it { is_expected.to have_one :issue_tracker_data } end describe 'Validations' do |