Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#63151] Add permissions, work package attributes and demo data to seeds

Dombi Attila9738808408f3
diff --git a/app/seeders/common.yml b/app/seeders/common.yml
index 97dfefa7b81..0c8fc536825 100644
--- a/app/seeders/common.yml
+++ b/app/seeders/common.yml
@@ -312,6 +312,7 @@ project_roles:
- :comment_news
- :view_wiki_pages
- :view_project_attributes
+ - :view_project_phases
- reference: :default_role_anonymous
t_name: Anonymous
position: 1
@@ -320,6 +321,7 @@ project_roles:
- :view_work_packages
- :view_wiki_pages
- :view_project_attributes
+ - :view_project_phases
- reference: :default_role_member
t_name: Member
position: 3
@@ -378,6 +380,7 @@ project_roles:
- :view_internal_comments
- :add_internal_comments
- :edit_own_internal_comments
+ - :view_project_phases
- reference: :default_role_reader
t_name: Reader
position: 4
@@ -402,6 +405,7 @@ project_roles:
- :view_team_planner
- :view_shared_work_packages
- :view_project_attributes
+ - :view_project_phases
- reference: :default_role_project_admin
t_name: Project admin
position: 5
diff --git a/app/seeders/demo_data/project_phase_seeder.rb b/app/seeders/demo_data/project_phase_seeder.rb
new file mode 100644
index 00000000000..2671a324a7b
--- /dev/null
+++ b/app/seeders/demo_data/project_phase_seeder.rb
@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module DemoData
+ class ProjectPhaseSeeder < Seeder
+ attr_reader :project
+ alias_method :project_data, :seed_data
+
+ def initialize(project, project_data)
+ super(project_data)
+ @project = project
+ end
+
+ def seed_data!
+ print_status " ↳ Activating project phases with dates"
+
+ return unless should_seed_phases?
+
+ ApplicationRecord.transaction do
+ activate_phases
+ configure_phases
+ end
+ end
+
+ private
+
+ def should_seed_phases?
+ project_data.lookup("project_phases") && project.phases.empty?
+ end
+
+ def phases_by_definition_id
+ @phases_by_definition_id ||=
+ Array(project_data.lookup("project_phases")).index_by do |config|
+ seed_data.find_reference(config["definition"]).id
+ end
+ end
+
+ def definitions
+ @definitions ||= begin
+ definition_refs = Array(project_data.lookup("project_phases")).pluck("definition")
+ seed_data.find_references(definition_refs).sort_by(&:position)
+ end
+ end
+
+ def activate_phases
+ ProjectPhases::ActivationService
+ .new(user: admin_user, project:, definitions:)
+ .call(active: true)
+ end
+
+ def configure_phases
+ initiating_date = Date.current
+ phases = project.phases.where(definition: definitions)
+
+ phases.each { |phase| set_phase_attributes(phase, initiating_date) }
+
+ ProjectPhases::RescheduleService
+ .new(user: admin_user, project:)
+ .call(phases:, from: initiating_date)
+ end
+
+ def set_phase_attributes(phase, initiating_date)
+ phase.duration = phases_by_definition_id[phase.definition_id]["duration"]
+ # Set the default initiating date in order to trigger the scheduler
+ phase.start_date = phase.finish_date = initiating_date
+ phase.save!(validate: false)
+ end
+ end
+end
diff --git a/app/seeders/demo_data/project_seeder.rb b/app/seeders/demo_data/project_seeder.rb
index 12d8a21ab97..edd4b476874 100644
--- a/app/seeders/demo_data/project_seeder.rb
+++ b/app/seeders/demo_data/project_seeder.rb
@@ -35,7 +35,8 @@ module DemoData
self.needs = WorkPackageSeeder.needs + [
BasicData::ProjectRoleSeeder,
- BasicData::GlobalRoleSeeder
+ BasicData::GlobalRoleSeeder,
+ BasicData::ProjectPhaseDefinitionSeeder
]
def seed_data!
@@ -54,6 +55,7 @@ module DemoData
# override to add additional seeders
def project_content_seeder_classes
[
+ DemoData::ProjectPhaseSeeder,
DemoData::WikiSeeder,
DemoData::WorkPackageSeeder,
DemoData::WorkPackageBoardSeeder,
diff --git a/app/seeders/standard.yml b/app/seeders/standard.yml
index 51f8e082892..9e2ca11be2f 100644
--- a/app/seeders/standard.yml
+++ b/app/seeders/standard.yml
@@ -74,6 +74,15 @@ projects:
status_code: on_track
t_status_explanation: All tasks are on schedule. The people involved know their tasks. The system is completely set up.
t_description: This is a short summary of the goals of this demo project.
+ project_phases:
+ - definition: :default_project_phase_initiating
+ duration: 20
+ - definition: :default_project_phase_planning
+ duration: 30
+ - definition: :default_project_phase_executing
+ duration: 40
+ - definition: :default_project_phase_closing
+ duration: 10
modules:
- work_package_tracking
- news
diff --git a/spec/seeders/demo_data/project_phase_seeder_spec.rb b/spec/seeders/demo_data/project_phase_seeder_spec.rb
new file mode 100644
index 00000000000..6a6cd0d212d
--- /dev/null
+++ b/spec/seeders/demo_data/project_phase_seeder_spec.rb
@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe DemoData::ProjectPhaseSeeder do
+ include_context "with basic seed data"
+
+ let!(:admin) { create(:admin) }
+ let!(:project) { create(:project) }
+ let(:full_seed_data) { Source::SeedDataLoader.get_data(only: %w[project_phases project_phase_colors]) }
+
+ subject(:seeder) { described_class.new(project, project_seed_data) }
+
+ before do
+ # Seed the phase definitions and colors that the seeder will reference
+ BasicData::ProjectPhaseColorSeeder.new(full_seed_data).seed!
+ BasicData::ProjectPhaseDefinitionSeeder.new(full_seed_data).seed!
+
+ # Make the references available to our test seed data
+ %i[default_project_phase_initiating default_project_phase_planning
+ default_project_phase_executing default_project_phase_closing].each do |ref|
+ if definition = full_seed_data.find_reference(ref)
+ project_seed_data.store_reference(ref, definition)
+ end
+ end
+ end
+
+ describe "#seed!" do
+ context "with project_phases defined in seed data" do
+ let(:project_seed_data) do
+ data_hash = YAML.load <<~SEEDING_DATA_YAML
+ project_phases:
+ - definition: :default_project_phase_initiating
+ duration: 5
+ - definition: :default_project_phase_planning
+ duration: 3
+ - definition: :default_project_phase_executing
+ duration: 8
+ SEEDING_DATA_YAML
+
+ Source::SeedData.new(data_hash)
+ end
+
+ it "activates the specified phases" do
+ expect { seeder.seed! }
+ .to change { project.phases.active.count }.from(0).to(3)
+
+ phase_names = project.phases.joins(:definition).pluck("project_phase_definitions.name")
+ expect(phase_names).to match_array(%w[Initiating Planning Executing])
+ end
+
+ it "sets durations and schedules from today" do
+ seeder.seed!
+
+ initiating = project.phases.joins(:definition).find_by(project_phase_definitions: { name: "Initiating" })
+ planning = project.phases.joins(:definition).find_by(project_phase_definitions: { name: "Planning" })
+ executing = project.phases.joins(:definition).find_by(project_phase_definitions: { name: "Executing" })
+
+ expect(initiating.duration).to eq 5
+ expect(planning.duration).to eq 3
+ expect(executing.duration).to eq 8
+
+ expect(initiating.start_date).to eq Date.current
+ expect(planning.start_date).to be > initiating.finish_date
+ expect(executing.start_date).to be > planning.finish_date
+ end
+
+ it "wraps operations in a transaction" do
+ # Mock the activation service to raise an error
+ allow(ProjectPhases::ActivationService).to receive(:new).and_raise(StandardError, "Test error")
+
+ expect { seeder.seed! }.to raise_error(StandardError, "Test error")
+ expect(project.phases.count).to eq 0 # Should be rolled back
+ end
+ end
+
+ context "without project_phases in seed data" do
+ let(:project_seed_data) { Source::SeedData.new({}) }
+
+ it "does not create any phases" do
+ expect { seeder.seed! }
+ .not_to change { project.phases.count }
+ end
+ end
+
+ context "when project already has phases" do
+ let(:project_seed_data) do
+ data_hash = YAML.load <<~SEEDING_DATA_YAML
+ project_phases:
+ - definition: :default_project_phase_initiating
+ duration: 5
+ SEEDING_DATA_YAML
+
+ Source::SeedData.new(data_hash)
+ end
+
+ before do
+ definition = full_seed_data.find_reference(:default_project_phase_initiating)
+ project.phases.create!(definition: definition, active: true, duration: 10)
+ end
+
+ it "does not modify existing phases" do
+ existing_phase = project.phases.first
+ original_attributes = existing_phase.attributes.dup
+
+ expect { seeder.seed! }
+ .not_to change { project.phases.count }
+
+ expect(existing_phase.reload.attributes).to eq(original_attributes)
+ end
+ end
+
+ context "with unknown phase references in seed data" do
+ let(:project_seed_data) do
+ data_hash = YAML.load <<~SEEDING_DATA_YAML
+ project_phases:
+ - definition: :nonexistent_phase_reference
+ duration: 5
+ - definition: :default_project_phase_initiating
+ duration: 3
+ SEEDING_DATA_YAML
+
+ Source::SeedData.new(data_hash)
+ end
+
+ it "raises an error for unknown references" do
+ expect { seeder.seed! }
+ .to raise_error(/Nothing registered with reference :nonexistent_phase_reference/)
+ end
+ end
+ end
+end