From e820cc30b8798c1d9e30d4e780c511b5ab395345 Mon Sep 17 00:00:00 2001
From: Matt Jankowski <matt@jankowski.online>
Date: Thu, 5 Sep 2024 07:54:27 -0400
Subject: [PATCH] Convert invites controller spec to system/request specs
(#31755)
---
app/views/invites/_invite.html.haml | 2 +-
spec/controllers/invites_controller_spec.rb | 84 ------------------
spec/requests/invites_spec.rb | 31 +++++++
.../support/matchers/private_cache_control.rb | 14 +++
spec/system/invites_spec.rb | 86 +++++++++++++++++++
spec/system/tags_spec.rb | 3 +
6 files changed, 135 insertions(+), 85 deletions(-)
delete mode 100644 spec/controllers/invites_controller_spec.rb
create mode 100644 spec/requests/invites_spec.rb
create mode 100644 spec/support/matchers/private_cache_control.rb
create mode 100644 spec/system/invites_spec.rb
diff --git a/app/views/invites/_invite.html.haml b/app/views/invites/_invite.html.haml
index 94e1a7112..892fdc5a0 100644
--- a/app/views/invites/_invite.html.haml
+++ b/app/views/invites/_invite.html.haml
@@ -1,4 +1,4 @@
-%tr
+%tr{ id: dom_id(invite) }
%td
.input-copy
.input-copy__wrapper
diff --git a/spec/controllers/invites_controller_spec.rb b/spec/controllers/invites_controller_spec.rb
deleted file mode 100644
index 192c5b00b..000000000
--- a/spec/controllers/invites_controller_spec.rb
+++ /dev/null
@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe InvitesController do
- render_views
-
- let(:user) { Fabricate(:user) }
-
- before do
- sign_in user
- end
-
- describe 'GET #index' do
- before do
- Fabricate(:invite, user: user)
- end
-
- context 'when everyone can invite' do
- before do
- UserRole.everyone.update(permissions: UserRole.everyone.permissions | UserRole::FLAGS[:invite_users])
- get :index
- end
-
- it 'returns http success' do
- expect(response).to have_http_status(:success)
- end
-
- it 'returns private cache control headers' do
- expect(response.headers['Cache-Control']).to include('private, no-store')
- end
- end
-
- context 'when not everyone can invite' do
- before do
- UserRole.everyone.update(permissions: UserRole.everyone.permissions & ~UserRole::FLAGS[:invite_users])
- get :index
- end
-
- it 'returns http forbidden' do
- expect(response).to have_http_status(403)
- end
- end
- end
-
- describe 'POST #create' do
- subject { post :create, params: { invite: { max_uses: '10', expires_in: 1800 } } }
-
- context 'when everyone can invite' do
- before do
- UserRole.everyone.update(permissions: UserRole.everyone.permissions | UserRole::FLAGS[:invite_users])
- end
-
- it 'succeeds to create a invite' do
- expect { subject }.to change(Invite, :count).by(1)
- expect(subject).to redirect_to invites_path
- expect(Invite.last).to have_attributes(user_id: user.id, max_uses: 10)
- end
- end
-
- context 'when not everyone can invite' do
- before do
- UserRole.everyone.update(permissions: UserRole.everyone.permissions & ~UserRole::FLAGS[:invite_users])
- end
-
- it 'returns http forbidden' do
- expect(subject).to have_http_status(403)
- end
- end
- end
-
- describe 'DELETE #destroy' do
- subject { delete :destroy, params: { id: invite.id } }
-
- let(:invite) { Fabricate(:invite, user: user, expires_at: nil) }
-
- it 'expires invite and redirects' do
- expect { subject }
- .to(change { invite.reload.expired? }.to(true))
- expect(response)
- .to redirect_to invites_path
- end
- end
-end
diff --git a/spec/requests/invites_spec.rb b/spec/requests/invites_spec.rb
new file mode 100644
index 000000000..8a5ad2ccd
--- /dev/null
+++ b/spec/requests/invites_spec.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Invites' do
+ let(:user) { Fabricate(:user) }
+
+ before { sign_in user }
+
+ context 'when not everyone can invite' do
+ before { UserRole.everyone.update(permissions: UserRole.everyone.permissions & ~UserRole::FLAGS[:invite_users]) }
+
+ describe 'GET /invites' do
+ it 'returns http forbidden' do
+ get invites_path
+
+ expect(response)
+ .to have_http_status(403)
+ end
+ end
+
+ describe 'POST /invites' do
+ it 'returns http forbidden' do
+ post invites_path, params: { invite: { max_users: '10', expires_in: 1800 } }
+
+ expect(response)
+ .to have_http_status(403)
+ end
+ end
+ end
+end
diff --git a/spec/support/matchers/private_cache_control.rb b/spec/support/matchers/private_cache_control.rb
new file mode 100644
index 000000000..7fcf56be3
--- /dev/null
+++ b/spec/support/matchers/private_cache_control.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_private_cache_control do
+ match do |page|
+ page.response_headers['Cache-Control'] == 'private, no-store'
+ end
+
+ failure_message do |page|
+ <<~ERROR
+ Expected page to have `Cache-Control` header with `private, no-store` but it has:
+ #{page.response_headers['Cache-Control']}
+ ERROR
+ end
+end
diff --git a/spec/system/invites_spec.rb b/spec/system/invites_spec.rb
new file mode 100644
index 000000000..648bbea82
--- /dev/null
+++ b/spec/system/invites_spec.rb
@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Invites' do
+ include ActionView::RecordIdentifier
+
+ let(:user) { Fabricate :user }
+
+ before do
+ host! 'localhost:3000' # TODO: Move into before for all system specs?
+ sign_in user
+ end
+
+ describe 'Viewing invites' do
+ it 'Lists existing user invites' do
+ invite = Fabricate :invite, user: user
+
+ visit invites_path
+
+ within css_id(invite) do
+ expect(page)
+ .to have_content(invite.uses)
+ .and have_private_cache_control
+ expect(copyable_field.value)
+ .to eq(public_invite_url(invite_code: invite.code))
+ end
+ end
+ end
+
+ describe 'Creating a new invite' do
+ it 'Saves the invite for the user' do
+ visit invites_path
+
+ fill_invite_form
+
+ expect { submit_form }
+ .to change(user.invites, :count).by(1)
+ end
+ end
+
+ describe 'Deleting an existing invite' do
+ it 'Expires the invite' do
+ invite = Fabricate :invite, user: user
+
+ visit invites_path
+
+ expect { delete_invite(invite) }
+ .to change { invite.reload.expired? }.to(true)
+
+ within css_id(invite) do
+ expect(page).to have_content I18n.t('invites.expired')
+ end
+ end
+ end
+
+ private
+
+ def css_id(record)
+ "##{dom_id(record)}" # TODO: Extract to system spec helper?
+ end
+
+ def copyable_field
+ within '.input-copy' do
+ find(:field, type: :text, readonly: true)
+ end
+ end
+
+ def submit_form
+ click_on I18n.t('invites.generate')
+ end
+
+ def delete_invite(invite)
+ within css_id(invite) do
+ click_on I18n.t('invites.delete')
+ end
+ end
+
+ def fill_invite_form
+ select I18n.t('invites.max_uses', count: 100),
+ from: I18n.t('simple_form.labels.defaults.max_uses')
+ select I18n.t("invites.expires_in.#{30.minutes.to_i}"),
+ from: I18n.t('simple_form.labels.defaults.expires_in')
+ check I18n.t('simple_form.labels.defaults.autofollow')
+ end
+end
diff --git a/spec/system/tags_spec.rb b/spec/system/tags_spec.rb
index e9ad970a5..f39c6bf0d 100644
--- a/spec/system/tags_spec.rb
+++ b/spec/system/tags_spec.rb
@@ -6,11 +6,14 @@ RSpec.describe 'Tags' do
describe 'Viewing a tag' do
let(:tag) { Fabricate(:tag, name: 'test') }
+ before { sign_in Fabricate(:user) }
+
it 'visits the tag page and renders the web app' do
visit tag_path(tag)
expect(page)
.to have_css('noscript', text: /Mastodon/)
+ .and have_private_cache_control
end
end
end