mqi 0.3.0

Idiomatic IBM® MQ Interface (MQI) and MQ Administration Interface (MQAI) APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

#![cfg(any(feature = "link", feature = "dlopen2"))]

use std::{borrow::Cow, collections::HashMap, error::Error};

#[cfg(not(feature = "mock"))]
use mqi::connection::{Credentials, ThreadNone};
use mqi::{
    Object, Properties, attribute,
    attribute::{AttributeType, AttributeValue, InqResItem},
    constants,
    get::Headers,
    header::fmt,
    open::SelectionString,
    prelude::*,
    test,
    types::{MQCMHO, MQXA, MessageFormat, MessageId, QueueManagerName, QueueName},
};

#[test]
fn no_message() -> Result<(), Box<dyn std::error::Error>> {
    const QUEUE: QueueName = QueueName(mqstr!("DEV.QUEUE.1"));
    #[allow(clippy::allow_attributes, unused_mut)]
    let mut connection;
    #[cfg(feature = "mock")]
    {
        connection = test::mock::connect_ok(|mock_library| {
            let mut seq = mockall::Sequence::new();
            test::mock::open_ok(mock_library, 0x0c0c, 1, &mut seq);
            test::mock::get_error(mock_library, constants::MQRC_NO_MSG_AVAILABLE, 1, &mut seq);
        });
    }
    #[cfg(not(feature = "mock"))]
    {
        let creds = test::credentials();
        let cred_options: Credentials<_> = creds.as_ref().into();
        connection = mqi::connect_lib::<ThreadNone, _>(test::mq_library(), &cred_options).warn_as_error()?;
    }
    let object = Object::open(
        &connection,
        &(
            QUEUE,
            constants::MQOO_INPUT_AS_Q_DEF,
            SelectionString("Root.MQMD.CorrelId = 0x0c0c0c0c"), // This should not exist
        ),
    )?;

    let mut buffer = vec![0; 4 * 1024]; // Use and consume a vector for the buffer
    let msg = object.get_data(&(), &mut buffer)?;

    assert_eq!(msg.warning(), None);
    assert_eq!(msg.discard_warning(), None);

    Ok(())
}

#[test]
fn put_get_message() -> Result<(), Box<dyn std::error::Error>> {
    const QUEUE: QueueName = QueueName(mqstr!("DEV.QUEUE.1"));
    #[allow(clippy::allow_attributes, unused_mut)]
    let mut connection;
    #[cfg(feature = "mock")]
    {
        connection = test::mock::connect_ok(|mock_library| {
            let mut seq = mockall::Sequence::new();
            test::mock::open_ok(mock_library, 0x0c0c, 1, &mut seq);
            mock_library.expect_MQPUT().returning(|_, _, _, _, _, _, cc, rc| {
                // TODO: add assertions here
                test::mock::mqi_outcome_ok(cc, rc);
            });
            test::mock::properties_ok(mock_library, 0x0d0d, 1, &mut seq);
            test::mock::get_ok(mock_library, "put_get_message test", 1, &mut seq);
        });
    }
    #[cfg(not(feature = "mock"))]
    {
        let creds = test::credentials();
        let cred_options: Credentials<_> = creds.as_ref().into();
        connection = mqi::connect_lib::<ThreadNone, _>(test::mq_library(), &cred_options).warn_as_error()?;
    }

    let object = Object::open(&connection, &(QUEUE, constants::MQOO_INPUT_SHARED | constants::MQOO_OUTPUT))?;

    let mid = object
        .put_message_with::<MessageId>(&(), "put_get_message test")
        .warn_as_error()?;

    let mut properties = Properties::new(&connection, MQCMHO::default())?;

    let buffer = vec![0; 4 * 1024]; // Use and consume a vector for the buffer
    let msg = object.get_as(
        &(
            &mut properties, // Get some properties
            mid,             // Only the message matching the output of put
        ),
        buffer,
    )?;

    let (msg, _msgid, format, headers): (Cow<[u8]>, MessageId, MessageFormat, Headers) =
        msg.discard_warning().expect("Message to be present");

    assert!(headers.all_headers().next().is_none());
    assert!(headers.error().is_none());
    assert_eq!(String::from_utf8_lossy(&msg), "put_get_message test");
    assert_eq!(format.fmt, fmt::MQFMT_STRING);

    Ok(())
}

#[test]
fn inq_qm() -> Result<(), Box<dyn std::error::Error>> {
    const INQ: &[attribute::AttributeType] = &[
        attribute::MQCA_Q_MGR_NAME,
        attribute::MQCA_ALTERATION_DATE,
        attribute::MQCA_DEAD_LETTER_Q_NAME,
        attribute::MQCA_ALTERATION_TIME,
        attribute::MQCA_CREATION_DATE,
        attribute::MQCA_CREATION_TIME,
        attribute::MQIA_CODED_CHAR_SET_ID,
        attribute::MQCA_DEF_XMIT_Q_NAME,
        // Hmmm... this works. Not documented for MQINQ though.
        #[expect(clippy::cast_possible_truncation)]
        unsafe {
            AttributeType::new(MQXA(constants::MQCA_VERSION.0), libmqm_sys::MQ_VERSION_LENGTH as u32)
        },
        attribute::MQIA_COMMAND_LEVEL,
    ];

    #[allow(clippy::allow_attributes, unused_mut)]
    let mut connection;
    #[cfg(feature = "mock")]
    {
        connection = test::mock::connect_ok(|mock_library| {
            let mut seq = mockall::Sequence::new();
            test::mock::open_ok(mock_library, 0x0c0c, 1, &mut seq);
            mock_library
                .expect_MQINQ()
                .returning(|_, _, _, _, int_len, ints, char_len, chars, cc, rc| {
                    use std::slice;

                    let char_slice =
                        unsafe { slice::from_raw_parts_mut(chars, char_len.try_into().expect("char_len should be positive")) };
                    char_slice.fill(32);
                    let int_slice =
                        unsafe { slice::from_raw_parts_mut(ints, int_len.try_into().expect("int_len should be positive")) };
                    int_slice.fill(0);
                    test::mock::mqi_outcome_ok(cc, rc);
                });
        });
    }
    #[cfg(not(feature = "mock"))]
    {
        let creds = test::credentials();
        let cred_options: Credentials<_> = creds.as_ref().into();

        connection = mqi::connect_lib::<ThreadNone, _>(test::mq_library(), &cred_options).warn_as_error()?;
    }

    let object = Object::open(connection, &(QueueManagerName(mqstr!("")), constants::MQOO_INQUIRE)).warn_as_error()?;

    let result = object.inquire(INQ)?;
    if let Some((rc, verb)) = result.warning() {
        eprintln!("MQRC warning: {verb} {rc}");
    }

    let values: HashMap<_, _> = result.iter().map(InqResItem::into_tuple).collect();

    for (attr, value) in values {
        match value {
            AttributeValue::Text(value) => println!("{attr}: {value:?}"),
            AttributeValue::Long(value) => println!("{attr}: {value}"),
        }
    }

    let r = object.inquire_item(attribute::MQCA_DEF_XMIT_Q_NAME).warn_as_error()?;
    println!("{r:?}");

    Ok(())
}

#[test]
fn put_message() -> Result<(), Box<dyn Error>> {
    const QUEUE: QueueName = QueueName(mqstr!("DEV.QUEUE.1"));
    #[allow(clippy::allow_attributes, unused_mut)]
    let mut connection;
    #[cfg(feature = "mock")]
    {
        connection = test::mock::connect_ok(|mock_library| {
            let mut seq = mockall::Sequence::new();
            test::mock::open_ok(mock_library, 0x0c0c, 1, &mut seq);
            mock_library.expect_MQPUT().returning(|_, _, _, _, _, _, cc, rc| {
                // TODO: add assertions here
                test::mock::mqi_outcome_ok(cc, rc);
            });
        });
    }
    #[cfg(not(feature = "mock"))]
    {
        let creds = test::credentials();
        let cred_options: Credentials<_> = creds.as_ref().into();
        connection = mqi::connect_lib::<ThreadNone, _>(test::mq_library(), &cred_options).warn_as_error()?;
    }

    let object = Object::open(connection, &(QUEUE, constants::MQOO_OUTPUT)).warn_as_error()?;

    object.put_message(&(), "message").warn_as_error()?;

    Ok(())
}