test-tool: add PrinReadKeys.Truncate test

This test registers PR key and then sends a PR-In read-keys request with
an ALLOCATION LENGTH value that forces response truncation. Ensure that
the ADDITIONAL LENGTH is *not* modified as a result of the truncation.

This test currently passes against TGT but fails against LIO (fix
pending).

Signed-off-by: David Disseldorp <ddiss@suse.de>

test-tool/Makefile.am

@@ -70,6 +70,7 @@ iscsi_test_cu_SOURCES = iscsi-test-cu.c \
 	test_preventallow_lun_reset.c \
 	test_preventallow_2_itnexuses.c \
 	test_prin_read_keys_simple.c \
+	test_prin_read_keys_truncate.c \
 	test_prin_serviceaction_range.c \
 	test_prin_report_caps.c \
 	test_prout_register_simple.c \

test-tool/iscsi-test-cu.c

@@ -158,6 +158,7 @@ static CU_TestInfo tests_preventallow[] = {
 
 static CU_TestInfo tests_prin_read_keys[] = {
         { (char *)"Simple", test_prin_read_keys_simple },
+        { (char *)"Truncate", test_prin_read_keys_truncate },
         CU_TEST_INFO_NULL
 };
 

test-tool/iscsi-test-cu.h

@@ -115,6 +115,7 @@ void test_preventallow_lun_reset(void);
 void test_preventallow_2_itnexuses(void);
 
 void test_prin_read_keys_simple(void);
+void test_prin_read_keys_truncate(void);
 void test_prin_serviceaction_range(void);
 void test_prin_report_caps_simple(void);
 

test-tool/test_prin_read_keys_truncate.c

@@ -0,0 +1,74 @@
+/* -*-  mode:c; tab-width:8; c-basic-offset:8; indent-tabs-mode:nil;  -*- */
+/*
+   Copyright (C) 2013 by Lee Duncan <lee@gonzoleeman.net>
+   Copyright (C) 2018 David Disseldorp
+
+   This program 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 2 of the License, or
+   (at your option) any later version.
+
+   This program 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 this program; if not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <stdio.h>
+#include <arpa/inet.h>
+
+#include <CUnit/CUnit.h>
+
+#include "iscsi.h"
+#include "scsi-lowlevel.h"
+#include "iscsi-support.h"
+#include "iscsi-test-cu.h"
+
+
+void
+test_prin_read_keys_truncate(void)
+{
+        const unsigned long long key = rand_key();
+        struct scsi_persistent_reserve_in_read_keys *rk = NULL;
+        int ret;
+
+        logging(LOG_VERBOSE, LOG_BLANK_LINE);
+        logging(LOG_VERBOSE, "Test Persistent Reserve IN READ_KEYS works when "
+                "truncated.");
+
+        ret = prout_register_and_ignore(sd, key);
+        if (ret == -2) {
+                CU_PASS("PERSISTENT RESERVE OUT is not implemented.");
+                return;
+        }
+        CU_ASSERT_EQUAL(ret, 0);
+
+        /*
+         * alloc_len=8 restricts the response buffer to only accepting the
+         * PRGENERATION and ADDITIONAL LENGTH fields.
+         */
+        ret = prin_read_keys(sd, &task, &rk, 8);
+        if (ret == -2) {
+                CU_PASS("PERSISTENT RESERVE IN is not implemented.");
+                prout_register_key(sd, 0, key);
+                return;
+        }
+        CU_ASSERT_EQUAL(ret, 0);
+
+        /*
+         * SPC5r17: 6.16.2 READ KEYS service action
+         * The ADDITIONAL LENGTH field indicates the number of bytes in
+         * the Reservation key list. The contents of the ADDITIONAL
+         * LENGTH field are not altered based on the allocation length.
+         */
+        CU_ASSERT_NOT_EQUAL(rk->additional_length, 0);
+        /* key array should have been truncated in the response */
+        CU_ASSERT_EQUAL(rk->num_keys, 0);
+
+        /* remove our key from the target */
+        ret = prout_register_key(sd, 0, key);
+        CU_ASSERT_EQUAL(0, ret);
+}