File: admin_tools_editconfig.t

package info (click to toggle)
request-tracker5 5.0.7%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 80,216 kB
  • sloc: javascript: 191,898; perl: 87,146; sh: 1,412; makefile: 487; python: 37; php: 15
file content (163 lines) | stat: -rw-r--r-- 5,685 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
use strict;
use warnings;

use Test::Deep;
use Data::Dumper ();

use RT::Test tests => undef, config => 'Set($ShowEditSystemConfig, 0);';

my ( $url, $m ) = RT::Test->started_ok;
ok( $m->login(), 'logged in' );

$m->follow_link_ok( { text => 'System Configuration' }, 'followed link to "System Configuration"' );
ok( !$m->find_link( text => 'Edit' ), 'no edit link' );
$m->get_ok('/Admin/Tools/EditConfig.html');
$m->content_contains('Permission Denied');
$m->warning_like( qr/Permission Denied/, 'Permission denied warning' );

RT::Test->stop_server;
RT->Config->Set( ShowEditSystemConfig => 1 );

( $url, $m ) = RT::Test->started_ok;
ok( $m->login(), 'logged in' );

$m->follow_link_ok( { text => 'System Configuration' }, 'followed link to "System Configuration"' );
$m->follow_link_ok( { text => 'History' }, 'followed link to History page' );
$m->follow_link_ok( { text => 'Edit' }, 'followed link to Edit page' );

# In the tests below, new_value is *always* the string we feed
# into the Web form.  For compound objects such as hashes and arrays,
# we have a separate expected member that is the Perl data structure
# resulting from feeding new_value into the Web interface.
my $tests = [
    {
        name      => 'change a string value',
        form_id   => 'form-System-Base_configuration',
        setting   => 'CorrespondAddress',
        new_value => 'rt-correspond-edited@example.com',
    },
    {
        name      => 'change a boolean value',
        form_id   => 'form-System-Outgoing_mail',
        setting   => 'NotifyActor',
        new_value => 1,
    },
    {
        name      => 'change an arrayref value',
        form_id   => 'form-System-Extra_security',
        setting   => 'ReferrerWhitelist',
        new_value => '["www.example.com:443", "www3.example.com:80"]',
        expected  => ['www.example.com:443', 'www3.example.com:80'],
    },
    {
        name      => 'change a hashref value',
        form_id   => 'form-System-Outgoing_mail',
        setting   => 'OverrideOutgoingMailFrom',
        new_value => '{"1":"new-outgoing-from@example.com"}',
        expected  => {1 => 'new-outgoing-from@example.com'},
    },
    {
        name      => 'change CustomFieldGroupings',
        form_id   => 'form-Web_interface-Base_configuration',
        setting   => 'CustomFieldGroupings',
        new_value => '{ "RT::Ticket": [ "Grouping Name", [ "CF Name" ] ] }',
        expected  => { 'RT::Ticket' => [ 'Grouping Name', [ 'CF Name' ] ] },
        converted => { 'RT::Ticket' => { Default =>  [ 'Grouping Name', [ 'CF Name' ] ] } },
    },
];

run_test( %{$_} ) for @{$tests};

# check tx log for configuration
my $transactions = RT::Transactions->new(RT->SystemUser);
$transactions->Limit(FIELD => 'ObjectType', VALUE =>  'RT::Configuration');
$transactions->OrderBy(FIELD => 'Created', ORDER => 'ASC');
my $tx_items = $transactions->ItemsArrayRef;

my $i = 0;
foreach my $change (@{$tests}) {
    check_transaction( $tx_items->[$i++], $change );
}

# check config history page
$m->get_ok( $url . '/Admin/Tools/ConfigHistory.html');
$i = 0;
foreach my $change (@{$tests}) {
    check_history_page_item($tx_items->[$i++], $change );
}

sub run_test {
    my %args = @_;

    diag $args{name} if $ENV{TEST_VERBOSE};

    $m->form_id( $args{form_id} );
    $m->untick( "$args{setting}-file", 1 );
    $m->submit_form_ok(
        {
            fields  => {
                $args{setting} => $args{new_value},
            },
        },
        'form was submitted successfully'
    );

    # RT::Config in the test is not running in the same process as the one in the test server.
    # ensure the config object in the test is up to date with the changes.
    RT->Config->LoadConfigFromDatabase();
    RT->Config->PostLoadCheck;

    $m->content_like( qr/$args{setting} changed from/, 'UI indicated the value was changed' );

    # RT::Configuration->Content returns the value as string.
    # in the test below we need to also ensure the new value is string.
    my $rt_configuration = RT::Configuration->new( RT->SystemUser );
    $rt_configuration->Load( $args{setting} );
    my $rt_configuration_value = $rt_configuration->Content;

    my $rt_config_value = RT->Config->Get( $args{setting} );

    is( $rt_configuration_value, stringify($args{expected}) || $args{new_value}, 'value from RT::Configuration->Load matches new value' );
    cmp_deeply( $rt_config_value, $args{converted} || $args{expected} || $args{new_value}, 'value from RT->Config->Get matches new value' );
}

sub check_transaction {
    my ($tx, $change) = @_;
    is($tx->ObjectType, 'RT::Configuration', 'tx is config change');
    is($tx->Field, $change->{setting}, 'tx matches field changed');
    is($tx->NewValue, stringify($change->{expected}) || $change->{new_value}, 'tx value matches');
}

sub check_history_page_item {
    my ($tx, $change) = @_;
    my $link = sprintf('ConfigHistory.html?id=%d#txn-%d', $tx->ObjectId, $tx->id);
    ok($m->find_link(url => $link), 'found tx link in history');
    if ($change->{expected}) {
        $m->text_contains(compactify($change->{expected}), 'fetched tx has new value');
    } else {
        $m->text_contains($change->{new_value});
    }
    $m->text_like(qr/$change->{setting} (?:added|changed)/, 'fetched tx has changed field');
}

sub compactify {
    my $value = stringify(shift);
    $value =~ s/\s+/ /g;
    return $value;
}

sub stringify {
    my $value = shift;

    return $value unless ref $value;

    local $Data::Dumper::Terse = 1;
    local $Data::Dumper::Indent = 2;
    local $Data::Dumper::Sortkeys = 1;

    my $output = Data::Dumper::Dumper $value;
    chomp $output;
    return $output;
}

done_testing;