File: session_hooks.t

package info (click to toggle)
libdancer2-perl 0.152000%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,820 kB
  • ctags: 536
  • sloc: perl: 8,034; sh: 51; makefile: 2
file content (167 lines) | stat: -rw-r--r-- 6,731 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
use strict;
use warnings;
use Test::More;

use File::Temp 0.22;
use YAML;

use LWP::UserAgent;

eval "use LWP::Protocol::PSGI";
plan skip_all => "LWP::Protocol::PSGI is needed for this test" if $@;

my @engines = qw(Simple);

my @hooks_to_test = qw(
  engine.session.before_retrieve
  engine.session.after_retrieve

  engine.session.before_create
  engine.session.after_create

  engine.session.before_destroy
  engine.session.after_destroy

  engine.session.before_flush
  engine.session.after_flush
);
#we'll set a flag here when each hook is called. Then our test will then verify this
my $test_flags = {};
my $tempdir = File::Temp::tempdir( CLEANUP => 1, TMPDIR => 1 );

#I need this to make sure it works with LWP::Protocol::PSGI See GH#447
BEGIN {
    $ENV{DANCER_APPHANDLER} = 'PSGI';
}

sub get_app_for_engine {
    my $engine = shift;
    use Dancer2;

    #Possibly this doesn't seem to have a real effect. See GH#447
    setting apphandler => 'PSGI';
    setting appdir => $tempdir;
    setting(
            engines => { #we'll need this for YAML sessions
                session => { engine => {session_dir => 't/sessions'}}
            }
    );
    set(show_errors  => 1,
        startup_info => 0,
        envoriment   => 'production'
    );
    setting(session => $engine);

    for my $hook (@hooks_to_test) {
        hook $hook => sub {
         $test_flags->{$hook} ||= 0;
         $test_flags->{$hook}++;
        }
    }

    get '/set_session' => sub {
       session foo => 'bar'; #setting causes a session flush
       return "ok";
    };
    get '/get_session' => sub {
      is session->read('foo'), 'bar', "Got the right session back";
      return "ok";
    };
    get '/destroy_session' => sub {
      app->destroy_session;
      return "ok";
    };

    #setup each hook again and test whether they return the correct type
    #there is unfortunately quite some duplication here.
    hook 'engine.session.before_create' => sub {
       my ($response) = @_;
       is ref($response), 'Dancer2::Core::Session',
                           'Correct response type returned in before_create';
    };
    hook 'engine.session.after_create' => sub {
       my ($response) = @_;
       is ref($response), 'Dancer2::Core::Session',
                            'Correct response type returned in after_create';
    };
    hook 'engine.session.after_retrieve' => sub {
       my ($response) = @_;
       is ref($response), 'Dancer2::Core::Session',
                            'Correct response type returned in after_retrieve';
    };
    #this returns dancer app. We'll register it with LWP::Protocol::PSGI
    dance;
}

foreach my $engine (@engines) {
    note "Testing against $engine engine";

    $test_flags = {};

    #This will hijack lwp requests to localhost:3000 and send them to our dancer app
    LWP::Protocol::PSGI->register(get_app_for_engine($engine)); #if I set to hijack a particular <host:port> the connection is refused.

    my $ua = LWP::UserAgent->new;
    $ua->cookie_jar({file => "$tempdir/.cookies.$engine.txt"});

    my $r = $ua->get("http://localhost:3000/set_session");
    is $r->content, "ok", "set_session ran ok";

    #we verify whether the hooks were called correctly.
    subtest 'verify hooks for session create and session flush' => sub {
        is $test_flags->{'engine.session.before_create'}, 1, "session.before_create called";
        is $test_flags->{'engine.session.after_create'}, 1, "session.after_create called";
        is $test_flags->{'engine.session.before_flush'}, 1, "session.before_flush called";
        is $test_flags->{'engine.session.after_flush'}, 1, "session.after_flush called";

        is $test_flags->{'engine.session.before_retrieve'}, undef, "session.before_retrieve not called";
        is $test_flags->{'engine.session.after_retrieve'}, undef, "session.after_retrieve not called";
        is $test_flags->{'engine.session.before_destroy'}, undef, "session.before_destroy not called";
        is $test_flags->{'engine.session.after_destroy'}, undef, "session.after_destroy not called";
    };

    subtest 'verify Handler::File (static content) does not retrieve session' => sub {
        my $r = $ua->get("http://localhost:3000/file.txt");

        # These should not change from previous subtest
        is $test_flags->{'engine.session.before_create'}, 1, "session.before_create not called";
        is $test_flags->{'engine.session.after_create'}, 1, "session.after_create not called";
        is $test_flags->{'engine.session.before_retrieve'}, undef, "session.before_retrieve not called";
        is $test_flags->{'engine.session.after_retrieve'}, undef, "session.after_retrieve not called";
    };

    $r = $ua->get("http://localhost:3000/get_session");
    is $r->content, "ok", "get_session ran ok";

    subtest 'verify hooks for session retrieve' => sub {
        is $test_flags->{'engine.session.before_retrieve'}, 1, "session.before_retrieve called";
        is $test_flags->{'engine.session.after_retrieve'}, 1, "session.after_retrieve called";

        is $test_flags->{'engine.session.before_create'}, 1, "session.before_create not called";
        is $test_flags->{'engine.session.after_create'}, 1, "session.after_create not called";
        is $test_flags->{'engine.session.before_flush'}, 1, "session.before_flush not called";
        is $test_flags->{'engine.session.after_flush'}, 1, "session.after_flush not called";
        is $test_flags->{'engine.session.before_destroy'}, undef, "session.before_destroy not called";
        is $test_flags->{'engine.session.after_destroy'}, undef, "session.after_destroy not called";
    };

    $r = $ua->get("http://localhost:3000/destroy_session");
    is $r->content, "ok", "destroy_session ran ok";

    subtest 'verify session destroy hooks' => sub {
        is $test_flags->{'engine.session.before_destroy'}, 1, "session.before_destroy called";
        is $test_flags->{'engine.session.after_destroy'}, 1, "session.after_destroy called";
        #not sure if before and after retrieve should be called when the session is destroyed. But this happens.
        is $test_flags->{'engine.session.before_retrieve'}, 2, "session.before_retrieve called";
        is $test_flags->{'engine.session.after_retrieve'}, 2, "session.after_retrieve called";

        is $test_flags->{'engine.session.before_create'}, 1, "session.before_create not called";
        is $test_flags->{'engine.session.after_create'}, 1, "session.after_create not called";
        is $test_flags->{'engine.session.before_flush'}, 1, "session.before_flush not called";
        is $test_flags->{'engine.session.after_flush'}, 1, "session.after_flush not called";
    };

    File::Temp::cleanup();
}

done_testing;