Append unit test & Doc (#2458)
Christophe Maudoux
4 years ago
parent
110974cce4
commit
e477a1cef8
@ -0,0 +1,46 @@ |
||||
Check DevOps plugin |
||||
=================== |
||||
|
||||
This plugin can be used to check the :doc:`DevOps<devopshandler>` file. |
||||
|
||||
Configuration |
||||
------------- |
||||
Just enable it in the manager (section “plugins”). |
||||
|
||||
Usage |
||||
----- |
||||
When enabled, ``/checkdevops`` URL path is handled by this plugin. |
||||
Then, you can paste a file to test your rules and headers. |
||||
|
||||
Example |
||||
~~~~~~~ |
||||
DevOps handler requires a rules.json file to define |
||||
access rules and headers: |
||||
|
||||
.. code-block:: json |
||||
|
||||
{ |
||||
"rules": { |
||||
"^/admin": "$uid eq 'admin'", |
||||
"default": "accept" |
||||
}, |
||||
"headers": { |
||||
"Auth-User": "$uid" |
||||
} |
||||
} |
||||
|
||||
.. note:: |
||||
|
||||
This plugin displays ALL user session attributes except |
||||
the hidden ones. |
||||
|
||||
You have to restrict access to specific users like DevOps teams |
||||
by setting an access rule like other VirtualHosts. |
||||
|
||||
By example: ``$groups =~ /\bdevops\b/`` |
||||
|
||||
.. attention:: |
||||
|
||||
Be careful to not display secret attributes. |
||||
|
||||
checkDevOps plugin uses hidden attributes option. |
||||
@ -0,0 +1,271 @@ |
||||
use Test::More; |
||||
use strict; |
||||
use IO::String; |
||||
use JSON; |
||||
|
||||
BEGIN { |
||||
require 't/test-lib.pm'; |
||||
} |
||||
|
||||
my $res; |
||||
my $file = '{ |
||||
"rules": { |
||||
"^/deny": "deny", |
||||
"^/testno": "$uid ne qq{dwho}", |
||||
"^/testyes": "$uid eq qq{dwho}", |
||||
"default": "accept" |
||||
}, |
||||
"headers": { |
||||
"User": "$uid", |
||||
"Mail": "$mail", |
||||
"Name": "$cn", |
||||
"UA": "$UA" |
||||
} |
||||
}'; |
||||
my $bad_file = '{ |
||||
"rules": { |
||||
"^/testno": "$uid ne qq{dwho}" |
||||
"default": "accept" |
||||
}, |
||||
"headers": { |
||||
"User": "$uid", |
||||
} |
||||
}'; |
||||
|
||||
my $client = LLNG::Manager::Test->new( { |
||||
ini => { |
||||
logLevel => 'error', |
||||
authentication => 'Demo', |
||||
userDB => 'Same', |
||||
requireToken => 1, |
||||
checkDevOps => 1, |
||||
hiddenAttributes => 'mail UA' |
||||
} |
||||
} |
||||
); |
||||
|
||||
## Try to authenticate |
||||
ok( $res = $client->_get( '/', accept => 'text/html' ), 'Get Menu', ); |
||||
count(1); |
||||
my ( $host, $url, $query ) = |
||||
expectForm( $res, '#', undef, 'user', 'password', 'token' ); |
||||
|
||||
$query =~ s/user=/user=dwho/; |
||||
$query =~ s/password=/password=dwho/; |
||||
ok( |
||||
$res = $client->_post( |
||||
'/', |
||||
IO::String->new($query), |
||||
length => length($query), |
||||
accept => 'text/html', |
||||
), |
||||
'Auth query' |
||||
); |
||||
count(1); |
||||
|
||||
my $id = expectCookie($res); |
||||
expectRedirection( $res, 'http://auth.example.com/' ); |
||||
|
||||
# CheckDevOps form |
||||
# ---------------- |
||||
ok( |
||||
$res = $client->_get( |
||||
'/checkdevops', |
||||
cookie => "lemonldap=$id", |
||||
accept => 'text/html' |
||||
), |
||||
'CheckDevOps form', |
||||
); |
||||
( $host, $url, $query ) = |
||||
expectForm( $res, undef, '/checkdevops', 'checkDevOpsFile', 'token' ); |
||||
ok( $res->[2]->[0] =~ m%<span trspan="checkDevOps">%, |
||||
'Found trspan="checkDevOps"' ) |
||||
or explain( $res->[2]->[0], 'trspan="checkDevOps"' ); |
||||
count(2); |
||||
|
||||
# POST without token |
||||
# ------------------ |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new(''), |
||||
cookie => "lemonldap=$id", |
||||
length => 0, |
||||
accept => 'text/html' |
||||
), |
||||
'POST checkdevops without token' |
||||
); |
||||
ok( $res->[2]->[0] =~ m%<span trspan="PE81"></span%, 'Found PE_NOTOKEN' ) |
||||
or explain( $res->[2]->[0], 'trspan="PE81"' ); |
||||
count(2); |
||||
( $host, $url, $query ) = |
||||
expectForm( $res, undef, '/checkdevops', 'checkDevOpsFile', 'token' ); |
||||
|
||||
# POST bad file |
||||
# ------------- |
||||
$query .= "&checkDevOpsFile=$bad_file"; |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new($query), |
||||
cookie => "lemonldap=$id", |
||||
length => length($query), |
||||
accept => 'text/html' |
||||
), |
||||
'POST checkdevops with bad file' |
||||
); |
||||
ok( $res->[2]->[0] =~ m%<span trspan="PE104"></span>%, |
||||
'Found PE_BAD_DEVOPS_FILE' ) |
||||
or explain( $res->[2]->[0], 'trspan="PE104"' ); |
||||
count(2); |
||||
( $host, $url, $query ) = |
||||
expectForm( $res, undef, '/checkdevops', 'checkDevOpsFile', 'token' ); |
||||
|
||||
# POST file |
||||
# --------- |
||||
$query .= "&checkDevOpsFile=$file"; |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new($query), |
||||
cookie => "lemonldap=$id", |
||||
length => length($query), |
||||
accept => 'text/html' |
||||
), |
||||
'POST checkdevops with file' |
||||
); |
||||
|
||||
# Headers |
||||
ok( $res->[2]->[0] =~ m%<b><span trspan="headers">HEADERS</span></b>%, |
||||
'HEADERS' ) |
||||
or explain( $res->[2]->[0], 'HEADERS' ); |
||||
ok( $res->[2]->[0] =~ m%Name: Doctor Who<br/>%, 'Hearder Name found' ) |
||||
or explain( $res->[2]->[0], 'Hearder Name' ); |
||||
ok( $res->[2]->[0] =~ m%User: dwho<br/>%, 'Hearder User found' ) |
||||
or explain( $res->[2]->[0], 'Hearder User' ); |
||||
|
||||
# Rules |
||||
ok( $res->[2]->[0] =~ m%<b><span trspan="rules">RULES</span></b>%, 'RULES' ) |
||||
or explain( $res->[2]->[0], 'RULES' ); |
||||
ok( $res->[2]->[0] =~ m%\^/testno: <span trspan="forbidden">%, 'testno' ) |
||||
or explain( $res->[2]->[0], 'testno' ); |
||||
ok( $res->[2]->[0] =~ m%default: <span trspan="allowed">%, 'default' ) |
||||
or explain( $res->[2]->[0], 'default' ); |
||||
ok( $res->[2]->[0] =~ m%\^/testyes: <span trspan="allowed">%, 'testyes' ) |
||||
or explain( $res->[2]->[0], 'testyes' ); |
||||
ok( $res->[2]->[0] =~ m%\^/deny: <span trspan="forbidden">%, 'deny' ) |
||||
or explain( $res->[2]->[0], 'deny' ); |
||||
ok( $res->[2]->[0] =~ m%\$uid eq qq{dwho}"%, 'file' ) |
||||
or explain( $res->[2]->[0], 'file' ); |
||||
count(10); |
||||
( $host, $url, $query ) = |
||||
expectForm( $res, undef, '/checkdevops', 'checkDevOpsFile', 'token' ); |
||||
|
||||
# POST file (json) |
||||
# ---------------- |
||||
$query .= "&checkDevOpsFile=$file"; |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new($query), |
||||
cookie => "lemonldap=$id", |
||||
length => length($query), |
||||
), |
||||
'POST checkdevops with file' |
||||
); |
||||
ok( $res = eval { from_json( $res->[2]->[0] ) }, 'Response is JSON' ) |
||||
or print STDERR "$@\n" . Dumper($res); |
||||
ok( $res->{ALERTE} eq 'alert-info', 'alert-info found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{FILE} =~ /headers/, 'headers found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{FILE} =~ /rules/, 'rules found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{FILE} =~ /"\$uid ne qq{dwho}"/, 'rule found' ) |
||||
or print STDERR Dumper($res); |
||||
count(6); |
||||
|
||||
# POST bad file (json) |
||||
# -------------------- |
||||
ok( |
||||
$res = $client->_get( |
||||
'/checkdevops', |
||||
cookie => "lemonldap=$id", |
||||
accept => 'text/html' |
||||
), |
||||
'CheckDevOps form', |
||||
); |
||||
( $host, $url, $query ) = |
||||
expectForm( $res, undef, '/checkdevops', 'checkDevOpsFile', 'token' ); |
||||
|
||||
$query .= "&checkDevOpsFile=$bad_file"; |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new($query), |
||||
cookie => "lemonldap=$id", |
||||
length => length($query), |
||||
), |
||||
'POST checkdevops with file' |
||||
); |
||||
ok( $res = eval { from_json( $res->[2]->[0] ) }, 'Response is JSON' ) |
||||
or print STDERR "$@\n" . Dumper($res); |
||||
ok( $res->{ALERTE} eq 'alert-danger', 'alert-danger found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{FILE} eq '', 'No file found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{MSG} eq 'PE104', 'PE104 found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{TOKEN} =~ /^\d{10}_\d+$/, 'Token found' ) |
||||
or print STDERR Dumper($res); |
||||
count(7); |
||||
|
||||
# POST with an expired token (json) |
||||
# --------------------------------- |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new($query), |
||||
cookie => "lemonldap=$id", |
||||
length => length($query), |
||||
), |
||||
'POST checkdevops without token' |
||||
); |
||||
ok( $res = eval { from_json( $res->[2]->[0] ) }, 'Response is JSON' ) |
||||
or print STDERR "$@\n" . Dumper($res); |
||||
ok( $res->{ALERTE} eq 'alert-warning', 'alert-warning found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{TOKEN} =~ /^\d{10}_\d+$/, 'Token found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{FILE} eq '', 'No file found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{MSG} eq 'PE82', 'PE82 found' ) |
||||
or print STDERR Dumper($res); |
||||
count(6); |
||||
|
||||
# POST without token (json) |
||||
# ------------------------- |
||||
ok( |
||||
$res = $client->_post( |
||||
'/checkdevops', |
||||
IO::String->new(''), |
||||
cookie => "lemonldap=$id", |
||||
length => 0, |
||||
), |
||||
'POST checkdevops without token' |
||||
); |
||||
ok( $res = eval { from_json( $res->[2]->[0] ) }, 'Response is JSON' ) |
||||
or print STDERR "$@\n" . Dumper($res); |
||||
ok( $res->{ALERTE} eq 'alert-warning', 'alert-warning found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{TOKEN} =~ /^\d{10}_\d+$/, 'Token found' ) |
||||
or print STDERR Dumper($res); |
||||
ok( $res->{MSG} eq 'PE81', 'PE81 found' ) |
||||
or print STDERR Dumper($res); |
||||
count(5); |
||||
|
||||
$client->logout($id); |
||||
|
||||
clean_sessions(); |
||||
|
||||
done_testing( count() ); |
||||
Loading…
Reference in new issue