openproject/modules/boards/spec/features/onboarding/boards_onboarding_tour_spec.rb

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 the OpenProject Foundation (OPF)
#
# 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-2017 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 docs/COPYRIGHT.rdoc for more details.
#++

require 'spec_helper'
require_relative './../support/onboarding_steps'

describe 'boards onboarding tour', js: true do
  let(:next_button) { find('.enjoyhint_next_btn') }
  let(:user) { FactoryBot.create :admin,
                                 member_in_project: demo_project,
                                 member_through_role: role}
  let(:permissions) do
    %i[
      show_board_views
      manage_board_views
      view_work_packages
      edit_work_packages
      add_work_packages
      manage_public_queries
    ]
  end
  let(:role) { FactoryBot.create(:role, permissions: permissions) }

  let(:demo_project) do
    FactoryBot.create :project,
                      name: 'Demo project',
                      identifier: 'demo-project',
                      is_public: true,
                      enabled_module_names: %w[work_package_tracking wiki board_view]
  end
  let(:scrum_project) do
    FactoryBot.create :project,
                      name: 'Scrum project',
                      identifier: 'your-scrum-project',
                      is_public: true,
                      enabled_module_names: %w[work_package_tracking wiki board_view]
  end
  let!(:wp_1) { FactoryBot.create(:work_package, project: demo_project) }
  let!(:wp_2) { FactoryBot.create(:work_package, project: scrum_project) }

  let!(:demo_board_view) { FactoryBot.create :board_grid_with_query, project: demo_project, name: 'Kanban', query: query }
  let!(:scrum_board_view) { FactoryBot.create :board_grid_with_query, project: scrum_project, name: 'Kanban', query: query }
  let(:query) { FactoryBot.create :query, user: user, project: demo_project }

  before do
    with_enterprise_token :board_view
    login_as user
    ::OrderedWorkPackage.create(query: query, work_package: wp_1, position: 0)
    allow(Setting).to receive(:demo_projects_available).and_return(true)
    allow(Setting).to receive(:boards_demo_data_available).and_return(true)
  end

  after do
    # Clear session to avoid that the onboarding tour starts
    page.execute_script("window.sessionStorage.clear();")
  end

  context 'as a new user' do
    it 'I see the board onboarding tour in the demo project' do
      # Set the tour parameter so that we can start on the wp page
      visit "/projects/#{demo_project.identifier}/work_packages?start_onboarding_tour=true"

      step_through_onboarding_wp_tour demo_project, wp_1

      step_through_onboarding_board_tour

      step_through_onboarding_main_menu_tour
    end

    it "I see the board onboarding tour in the scrum project" do
      # Set sessionStorage value so that the tour knows that it is in the scum tour
      page.execute_script("window.sessionStorage.setItem('openProject-onboardingTour', 'startMainTourFromBacklogs');");

      # Set the tour parameter so that we can start on the wp page
      visit "/projects/#{scrum_project.identifier}/work_packages?start_onboarding_tour=true"

      step_through_onboarding_wp_tour scrum_project, wp_2

      step_through_onboarding_board_tour

      step_through_onboarding_main_menu_tour
    end
  end
end