pyrox.dev / nixpkgs
lol
fork atom

nixos/test-driver/Logger: Replace invalid UTF-8

Regression introduced by d84741a4bfb6ed2531ec7154479c147d2c9a737c.

The mentioned commit actually is a good thing, because we now get the
output from the X session.

Unfortunately, for the i3wm test, the i3-config-wizard prints out the
raw keyboard symbols directly coming from xcb, so the output isn't
necessarily proper UTF-8.

As the XML::Writer already expects valid UTF-8 input, we assume that
everything that comes into sanitise() will be UTF-8 from the start. So
we just decode() it using FB_DEFAULT as the check argument so that
every invalid character is replaced by the unicode replacement
character:

https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character

We simply re-oncode it again afterwards and return it, so we should
always get out valid UTF-8 in the log XML.

For more information about FB_DEFAULT and FB_CROAK, have a look at:

http://search.cpan.org/~dankogai/Encode-2.84/Encode.pm#Handling_Malformed_Data

Signed-off-by: aszlig <aszlig@redmoonstudios.org>

aszlig cb796ccd 8de756d4

options
unified split
Changed files
+3 -1
nixos
lib
test-driver
Logger.pm
+3 -1
nixos/lib/test-driver/Logger.pm 
···

       
3

       
 

       
use strict;


     

       
4

       
 

       
use Thread::Queue;


     

       
5

       
 

       
use XML::Writer;


     

       

       

       
     

       
6

       
 

       



     

       
7

       
 

       
sub new {


     

       
8

       
 

       
    my ($class) = @_;


     
···

       
56

       
 

       
sub sanitise {


     

       
57

       
 

       
    my ($s) = @_;


     

       
58

       
 

       
    $s =~ s/[[:cntrl:]\xff]//g;


     

       
59

       
-

       
    return $s;


     

       

       

       
     

       
60

       
 

       
}


     

       
61

       
 

       



     

       
62

       
 

       
sub log {


     
···

       
3

       
 

       
use strict;


     

       
4

       
 

       
use Thread::Queue;


     

       
5

       
 

       
use XML::Writer;


     

       
6

       
+

       
use Encode qw(decode encode);


     

       
7

       
 

       



     

       
8

       
 

       
sub new {


     

       
9

       
 

       
    my ($class) = @_;


     
···

       
57

       
 

       
sub sanitise {


     

       
58

       
 

       
    my ($s) = @_;


     

       
59

       
 

       
    $s =~ s/[[:cntrl:]\xff]//g;


     

       
60

       
+

       
    $s = decode('UTF-8', $s, Encode::FB_DEFAULT);


     

       
61

       
+

       
    return encode('UTF-8', $s, Encode::FB_CROAK);


     

       
62

       
 

       
}


     

       
63

       
 

       



     

       
64

       
 

       
sub log {