/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl.xml

  • Committer: Teddy Hogeborn
  • Date: 2021-02-03 23:10:42 UTC
  • Revision ID: teddy@recompile.se-20210203231042-2z3egrvpo1zt7nej
mandos-ctl: Fix bad test for command.Remove and related minor issues

The test for command.Remove removes all clients from the spy server,
and then loops over all clients, looking for the corresponding Remove
command as recorded by the spy server.  But since since there aren't
any clients left after they were removed, no assertions are made, and
the test therefore does nothing.  Fix this.

In tests for command.Approve and command.Deny, add checks that clients
were not somehow removed by the command (in which case, likewise, no
assertions are made).

Add related checks to TestPropertySetterCmd.runTest; i.e. test that a
sequence is not empty before looping over it and making assertions.

* mandos-ctl (TestBaseCommands.test_Remove): Save a copy of the
  original "clients" dict, and loop over those instead.  Add assertion
  that all clients were indeed removed.  Also fix the code which looks
  for the Remove command, which now needs to actually work.
  (TestBaseCommands.test_Approve, TestBaseCommands.test_Deny): Add
  assertion that there are still clients before looping over them.
  (TestPropertySetterCmd.runTest): Add assertion that the list of
  values to get is not empty before looping over them.  Also add check
  that there are still clients before looping over clients.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-ctl">
5
 
<!ENTITY TIMESTAMP "2019-03-07">
 
5
<!ENTITY TIMESTAMP "2019-07-29">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
69
69
          <arg choice="plain"><option>--dump-json</option></arg>
70
70
          <arg choice="plain"><option>-j</option></arg>
71
71
      </group>
 
72
      <arg><option>--debug</option></arg>
72
73
      <group>
73
74
        <arg rep='repeat' choice='plain'>
74
75
          <replaceable>CLIENT</replaceable>
162
163
        </group>
163
164
      </group>
164
165
      <sbr/>
 
166
      <arg><option>--debug</option></arg>
165
167
      <group choice="req">
166
168
        <arg choice="plain"><option>--all</option></arg>
167
169
        <arg choice="plain"><option>-a</option></arg>
180
182
          <arg choice="plain"><option>--remove</option></arg>
181
183
          <arg choice="plain"><option>-r</option></arg>
182
184
      </group>
 
185
      <sbr/>
 
186
      <arg><option>--debug</option></arg>
183
187
      <group choice="req">
184
188
        <arg choice="plain"><option>--all</option></arg>
185
189
        <arg choice="plain"><option>-a</option></arg>
194
198
        <arg choice="plain"><option>--is-enabled</option></arg>
195
199
        <arg choice="plain"><option>-V</option></arg>
196
200
      </group>
 
201
      <arg><option>--debug</option></arg>
197
202
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
198
203
    </cmdsynopsis>
199
204
    <cmdsynopsis>
507
512
      </varlistentry>
508
513
      
509
514
      <varlistentry>
 
515
        <term><option>--debug</option></term>
 
516
        <listitem>
 
517
          <para>
 
518
            Show debug output; currently, this means show D-Bus calls.
 
519
          </para>
 
520
        </listitem>
 
521
      </varlistentry>
 
522
      
 
523
      <varlistentry>
510
524
        <term><option>--check</option></term>
511
525
        <listitem>
512
526
          <para>
543
557
  
544
558
  <refsect1 id="example">
545
559
    <title>EXAMPLE</title>
 
560
    <!-- Name of test methods in class Test_commands_from_options are
 
561
         written in comments below.  When adding an example, add a
 
562
         test too which tests the documented behavior. -->
546
563
    <informalexample>
 
564
      <!-- Test method: test_manual_page_example_1() -->
547
565
      <para>
548
566
        To list all clients:
549
567
      </para>
553
571
    </informalexample>
554
572
    
555
573
    <informalexample>
 
574
      <!-- Test method: test_manual_page_example_2() -->
556
575
      <para>
557
576
        To list <emphasis>all</emphasis> settings for the clients
558
577
        named <quote>foo1.example.org</quote> and <quote
567
586
    </informalexample>
568
587
    
569
588
    <informalexample>
 
589
      <!-- Test method: test_manual_page_example_3() -->
570
590
      <para>
571
591
        To enable all clients:
572
592
      </para>
576
596
    </informalexample>
577
597
    
578
598
    <informalexample>
 
599
      <!-- Test method: test_manual_page_example_4() -->
579
600
      <para>
580
601
        To change timeout and interval value for the clients
581
602
        named <quote>foo1.example.org</quote> and <quote
584
605
      <para>
585
606
 
586
607
<!-- do not wrap this line -->
587
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
608
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
588
609
 
589
610
      </para>
590
611
    </informalexample>
591
612
    
592
613
    <informalexample>
 
614
      <!-- Test method: test_manual_page_example_5() -->
593
615
      <para>
594
 
        To approve all clients currently waiting for it:
 
616
        To approve all clients currently waiting for approval:
595
617
      </para>
596
618
      <para>
597
619
        <userinput>&COMMANDNAME; --approve --all</userinput>