guile-zlib/tests/zlib.scm

;;; -*- mode: scheme; coding: utf-8; -*-
;;; Guile-zlib --- Functional package management for GNU
;;; Copyright © 2016, 2019, 2021, 2024 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2023 Artyom V. Poptsov <poptsov.artyom@gmail.com>
;;;
;;; This file is part of Guile-zlib.
;;;
;;; Guile-zlib is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; Guile-zlib is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with Guile-zlib.  If not, see <http://www.gnu.org/licenses/>.

(define-module (test-zlib)
  #:use-module (zlib)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-11)
  #:use-module (srfi srfi-64)
  #:use-module (srfi srfi-26)
  #:use-module (ice-9 binary-ports)
  #:use-module (rnrs bytevectors)
  #:use-module (rnrs io ports)
  #:use-module (ice-9 match))

(test-begin "zlib")

(define (random-seed)
  (logxor (getpid) (car (gettimeofday))))

(define %seed
  (let ((seed (random-seed)))
    (format (current-error-port) "random seed for tests: ~a~%"
            seed)
    (seed->random-state seed)))

(define (random-bytevector n)
  "Return a random bytevector of N bytes."
  (let ((bv (make-bytevector n)))
    (let loop ((i 0))
      (if (< i n)
          (begin
            (bytevector-u8-set! bv i (random 256 %seed))
            (loop (1+ i)))
          bv))))

(let ((str "αβγ"))
  ;; Guile 2.x lacks 'call-with-output-bytevector'.
  (unless (defined? 'call-with-output-bytevector) (test-skip 1))
  (test-equal "port encoding is inherited"
    str
    (let ((bv (call-with-output-bytevector
               (lambda (o)
; has to be set because call-with-output-bytevector ignores %default-port-encoding.
                 (set-port-encoding! o "UTF-8")
                 (call-with-zlib-output-port
                  o
                  (lambda (o)
; force encoding here to reveal a mismatch on read.
                    (set-port-encoding! o "UTF-8")
                    (write str o)))))))
      (with-fluids ((%default-port-encoding "UTF-8"))
        (call-with-input-bytevector
         bv
         (lambda (o)
; has to be set because call-with-input-bytevector ignores %default-port-encoding; see above.
           (set-port-encoding! o "UTF-8")
           (call-with-zlib-input-port o read)))))))

(test-assert "compression/decompression pipe"
  (let ((data (random-bytevector (+ (random 10000)
                                    (* 20 1024)))))
    (match (pipe)
      ((parent . child)
       (match (primitive-fork)
         (0                                       ;compress
          (dynamic-wind
            (const #t)
            (lambda ()
              (close-port parent)
              (call-with-gzip-output-port child
                (lambda (port)
                  (put-bytevector port data))))
            (lambda ()
              (primitive-exit 0))))
         (pid                                     ;decompress
          (begin
            (close-port child)
            (let ((received (call-with-gzip-input-port parent
                              (lambda (port)
                                (get-bytevector-all port))
                              #:buffer-size (* 64 1024))))
              (match (waitpid pid)
                ((_ . status)
                 (and (zero? status)
                      (port-closed? parent)
                      (bytevector=? received data))))))))))))

(unless (file-exists? "/dev/full") (test-skip 1))
(test-assert "gzip output port, error"
  (catch 'zlib-error
    (lambda ()
      (call-with-output-file "/dev/full"
        (lambda (p)
          (let ((p (make-gzip-output-port p)))
	    (put-bytevector p (random-bytevector 262140))
	    (force-output p)
	    (close-port p))))
      #f)
    (lambda (key ret code message . _)
      (and (= code Z_ERRNO)
           (string-contains message "No space left")
           (string-contains
            (call-with-output-string
              (lambda (port)
                (print-exception port #f key (list key ret code message))))
            "No space left")))))

(test-assert "raw compress/decompress"
  (let* ((data (random-bytevector (+ (random 10000) (* 20 1024))))
         (cdata (compress data))
         (ucdata (uncompress cdata)))
    (equal? data ucdata)))

(define (test-zlib n fmt level)
  (test-assert (format #f "zlib ports [size: ~a, format: ~a, level: ~a]"
                       n fmt level)
    (let* ((size (pk 'size (+ (random n %seed) n)))
           (data (random-bytevector size)))
      (let*-values (((port get)
                     (open-bytevector-output-port))
                    ((compressed)
                     (make-zlib-output-port port
                                            #:level level
                                            #:format fmt)))
        (put-bytevector compressed data)
        (close-port compressed)
        (let ((data2 (get-bytevector-all
                      (make-zlib-input-port
                       (open-bytevector-input-port (get))
                       #:format fmt))))
          (pk 'sizes size 'vs (bytevector-length data2))
          (bytevector=? data2 data))))))

(for-each (lambda (n)
            (for-each (lambda (format)
                        (for-each (lambda (level)
                                    (test-zlib n format level))
                                  (iota 9 1)))
                      '(deflate zlib gzip)))
          (list (expt 2 8) (expt 2 10) (expt 2 12)
                (expt 2 14) (expt 2 18)))

;; This test checks if "uncompress" is able to allocate enough memory for the
;; output when the input data has high compression ratio properly (e.g. when the
;; input data is but a lots of compressed zeroes.)
;;
;; See <https://notabug.org/guile-zlib/guile-zlib/issues/4>
(let* ((data        (make-bytevector 100000 0))
       (data-length (bytevector-length data)))
  (test-equal "uncompress: High compression ratio"
    data-length
    (let ((compressed-data (compress data)))
      (bytevector-length (uncompress compressed-data)))))

(let ((bv (compress #vu8(0))))
  (unless (= 9 (bytevector-length bv)) (test-skip 1))
  (test-equal "uncompress: input size times 1.5 is a fraction"
    #vu8(0)
    ;; In 0.2.0, this would throw:
    ;;   (wrong-type-arg #f "Wrong type (expecting ~A): ~S" ("exact integer" 27/2) (27/2))
    ;; where 27/2 is 9x1.5 and 9 the size of BV.
    (uncompress bv)))

(test-end)