Configure capabilities on the source/target field in the ATTACH frame

Author: MarcialRosales

deps/amqp10_client/.gitignore

@@ -26,3 +26,5 @@ amqp10_client.d
 
 # Downloaded ActiveMQ.
 /test/system_SUITE_data/apache-activemq-*
+/test/system_SUITE_data/ibmmq/mq-container
+/test/system_SUITE_data/ibmmq/*.tar.gz

deps/amqp10_client/BUILD.bazel

@@ -116,13 +116,14 @@ rabbitmq_integration_suite(
     size = "medium",
     additional_beam = [
         "test/activemq_ct_helpers.beam",
+        "test/ibmmq_ct_helpers.beam",
         "test/mock_server.beam",
     ],
     data = [
-        "@activemq//:exec_dir",
+        "@activemq//:exec_dir",        
     ],
     test_env = {
-        "ACTIVEMQ": "$TEST_SRCDIR/$TEST_WORKSPACE/external/activemq/bin/activemq",
+        "ACTIVEMQ": "$TEST_SRCDIR/$TEST_WORKSPACE/external/activemq/bin/activemq"        
     },
     deps = TEST_DEPS,
 )
@@ -139,6 +140,7 @@ eunit(
     name = "eunit",
     compiled_suites = [
         ":test_activemq_ct_helpers_beam",
+        ":test_ibmmq_ct_helpers_beam",
         ":test_mock_server_beam",
     ],
     target = ":test_erlang_app",

deps/amqp10_client/Makefile

@@ -68,6 +68,6 @@ $(ACTIVEMQ): \
 test/system_SUITE_data/apache-activemq-$(ACTIVEMQ_VERSION)-bin.tar.gz:
 	$(gen_verbose) $(call core_http_get,$@,$(ACTIVEMQ_URL))
 
-tests:: $(ACTIVEMQ)
+tests:: $(ACTIVEMQ) 
 
-ct ct-system: $(ACTIVEMQ)
+ct ct-system: $(ACTIVEMQ) 

deps/amqp10_client/app.bzl

@@ -126,6 +126,14 @@ def test_suite_beam_files(name = "test_suite_beam_files"):
         app_name = "amqp10_client",
         erlc_opts = "//:test_erlc_opts",
     )
+    erlang_bytecode(
+        name = "test_ibmmq_ct_helpers_beam",
+        testonly = True,
+        srcs = ["test/ibmmq_ct_helpers.erl"],
+        outs = ["test/ibmmq_ct_helpers.beam"],
+        app_name = "amqp10_client",
+        erlc_opts = "//:test_erlc_opts",
+    )
     erlang_bytecode(
         name = "test_mock_server_beam",
         testonly = True,

deps/amqp10_client/src/amqp10_client.erl

@@ -19,7 +19,7 @@
          end_session/1,
          attach_sender_link/3,
          attach_sender_link/4,
-         attach_sender_link/5,
+         attach_sender_link/5,        
          attach_sender_link_sync/3,
          attach_sender_link_sync/4,
          attach_sender_link_sync/5,
@@ -166,6 +166,8 @@ end_session(Pid) ->
 %% for the link before returning.
 attach_sender_link_sync(Session, Name, Target) ->
     attach_sender_link_sync(Session, Name, Target, mixed).
+-spec attach_sender_link_sync(pid(), binary(), binary()) ->
+    {ok, link_ref()} | link_timeout.
 
 %% @doc Synchronously attach a link on 'Session'.
 %% This is a convenience function that awaits attached event
@@ -271,9 +273,10 @@ attach_receiver_link(Session, Name, Source, SettleMode, Durability, Filter) ->
 %% caller using an amqp10_event of the following format:
 %% {amqp10_event, {link, LinkRef, attached | {detached, Why}}}
 -spec attach_receiver_link(pid(), binary(), binary(), snd_settle_mode(),
-                           terminus_durability(), filter(), properties()) ->
+                           terminus_durability(), filter(), properties()) ->    
     {ok, link_ref()}.
-attach_receiver_link(Session, Name, Source, SettleMode, Durability, Filter, Properties)
+attach_receiver_link(Session, Name, Source, SettleMode, Durability, Filter, 
+    Properties)
   when is_pid(Session) andalso
        is_binary(Name) andalso
        is_binary(Source) andalso

deps/amqp10_client/src/amqp10_client_session.erl

@@ -73,11 +73,14 @@
 -type rcv_settle_mode() :: first | second.
 
 -type terminus_durability() :: none | configuration | unsettled_state.
+-type terminus_capabilities() :: none | binary() | list().
 
 -type target_def() :: #{address => link_address(),
-                        durable => terminus_durability()}.
+                        durable => terminus_durability(),
+                        capabilities => terminus_capabilities()}.
 -type source_def() :: #{address => link_address(),
-                        durable => terminus_durability()}.
+                        durable => terminus_durability(),
+                        capabilities => terminus_capabilities()}.
 
 -type attach_role() :: {sender, target_def()} | {receiver, source_def(), pid()}.
 
@@ -109,6 +112,7 @@
 -export_type([snd_settle_mode/0,
               rcv_settle_mode/0,
               terminus_durability/0,
+              terminus_capabilities/0,
               attach_args/0,
               attach_role/0,
               target_def/0,
@@ -713,20 +717,24 @@ make_source(#{role := {sender, _}}) ->
 make_source(#{role := {receiver, #{address := Address} = Source, _Pid}, filter := Filter}) ->
     Durable = translate_terminus_durability(maps:get(durable, Source, none)),
     TranslatedFilter = translate_filters(Filter),
+    Capabilities = translate_terminus_capabilities(maps:get(capabilities, Source, none)),
     #'v1_0.source'{address = {utf8, Address},
                    durable = {uint, Durable},
-                   filter = TranslatedFilter}.
+                   filter = TranslatedFilter,
+                   capabilities = Capabilities}.
 
 make_target(#{role := {receiver, _Source, _Pid}}) ->
     #'v1_0.target'{};
 make_target(#{role := {sender, #{address := Address} = Target}}) ->
     Durable = translate_terminus_durability(maps:get(durable, Target, none)),
+    Capabilities = translate_terminus_capabilities(maps:get(capabilities, Target, none)),
     TargetAddr = case is_binary(Address) of
                      true -> {utf8, Address};
                      false -> Address
                  end,
     #'v1_0.target'{address = TargetAddr,
-                   durable = {uint, Durable}}.
+                   durable = {uint, Durable},
+                   capabilities = Capabilities}.
 
 max_message_size(#{max_message_size := Size})
   when is_integer(Size) andalso
@@ -771,6 +779,19 @@ filter_value_type({T, _} = V) when is_atom(T) ->
     %% looks like an already tagged type, just pass it through
     V.
 
+translate_terminus_capabilities(none) ->
+    undefined;
+translate_terminus_capabilities(Capabilities) when is_binary(Capabilities) ->
+    {symbol, Capabilities};
+translate_terminus_capabilities(CapabilitiesList) when is_list(CapabilitiesList) ->
+    {array, symbol, [filter_capability(V) || V <- CapabilitiesList]}.
+
+filter_capability(V) when is_binary(V) ->
+    {symbol, V};
+filter_capability({T, _} = V) when is_atom(T) ->
+    %% looks like an already tagged type, just pass it through
+    V.
+
 % https://people.apache.org/~rgodfrey/amqp-1.0/apache-filters.html
 translate_legacy_amqp_headers_binding(LegacyHeaders) ->
     {map,
@@ -846,6 +867,7 @@ send_attach(Send, #{name := Name, role := RoleTuple} = Args, {FromPid, _},
                             rcv_settle_mode = rcv_settle_mode(Args),
                             target = Target,
                             max_message_size = MaxMessageSize},
+
     ok = Send(Attach, State),
 
     Ref = make_link_ref(Role, self(), OutHandle),

deps/amqp10_client/test/activemq_ct_helpers.erl

@@ -63,6 +63,7 @@ start_activemq_nodes(Config) ->
     ActivemqCmd = ?config(activemq_cmd, Config1),
     TCPPort = rabbit_ct_broker_helpers:get_node_config(Config1, 0, tcp_port_amqp),
     ConfigFile = ?config(activemq_config_filename, Config1),
+    ct:log("Running ~p", [ActivemqCmd]),
     Cmd = [ActivemqCmd,
            "start",
            {"-Dtestsuite.tcp_port_amqp=~b", [TCPPort]},

deps/amqp10_client/test/ibmmq_ct_helpers.erl

@@ -0,0 +1,89 @@
+%% This Source Code Form is subject to the terms of the Mozilla Public
+%% License, v. 2.0. If a copy of the MPL was not distributed with this
+%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
+%%
+%% Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
+%%
+
+-module(ibmmq_ct_helpers).
+
+-include_lib("common_test/include/ct.hrl").
+
+-export([setup_steps/0,
+         teardown_steps/0,
+         init_config/1,
+         start_ibmmq_server/1,
+         stop_ibmmq_server/1]).
+
+setup_steps() ->
+    [fun init_config/1,
+     fun start_ibmmq_server/1
+    ].
+
+teardown_steps() ->
+    [
+     fun stop_ibmmq_server/1
+    ].
+
+init_config(Config) ->
+    NodeConfig = [{tcp_port_amqp, 5672}],
+    rabbit_ct_helpers:set_config(Config, [ {rmq_nodes, [NodeConfig]},
+                                            {rmq_hostname, "localhost"},
+                                            {tcp_hostname_amqp, "localhost"},
+                                            {sasl, {plain, <<"app">>, <<"passw0rd">>}} ]).
+
+start_ibmmq_server(Config) ->
+    IBMmqCmd = filename:join([?config(data_dir, Config), "ibmmq_runner"]),
+    Cmd = [IBMmqCmd, "start"],
+    ct:log("Running command ~p", [Cmd]),
+    case rabbit_ct_helpers:exec(Cmd, []) of
+        {ok, _} -> wait_for_ibmmq_nodes(Config);
+        Error   -> ct:pal("Error: ~tp", [Error]),
+                   {skip, "Failed to start IBM MQ"}
+    end.
+
+wait_for_ibmmq_nodes(Config) ->
+    Hostname = ?config(rmq_hostname, Config),
+    Ports = rabbit_ct_broker_helpers:get_node_configs(Config, tcp_port_amqp),
+    wait_for_ibmmq_ports(Config, Hostname, Ports).
+
+wait_for_ibmmq_ports(Config, Hostname, [Port | Rest]) ->
+    ct:log("Waiting for IBM MQ on port ~b", [Port]),
+    case wait_for_ibmmq_port(Hostname, Port, 60) of
+        ok ->
+            ct:log("IBM MQ ready on port ~b", [Port]),
+            wait_for_ibmmq_ports(Config, Hostname, Rest);
+        {error, _} ->
+            Msg = lists:flatten(
+                    io_lib:format(
+                      "Failed to start IBM MQ on port ~b; see IBM MQ logs",
+                      [Port])),
+            ct:pal(?LOW_IMPORTANCE, Msg, []),
+            {skip, Msg}
+    end;
+wait_for_ibmmq_ports(Config, _, []) ->
+    Config.
+
+wait_for_ibmmq_port(_, _, 0) ->
+    {error, econnrefused};
+wait_for_ibmmq_port(Hostname, Port, Retries) ->
+    case gen_tcp:connect(Hostname, Port, []) of
+        {ok, Connection} ->
+            gen_tcp:close(Connection),
+            ok;
+        {error, econnrefused} ->
+            timer:sleep(1000),
+            wait_for_ibmmq_port(Hostname, Port, Retries - 1);
+        Error ->
+            Error
+    end.
+
+stop_ibmmq_server(Config) ->
+    IBMmqCmd = filename:join([?config(data_dir, Config), "ibmmq_runner"]),
+    Cmd = [IBMmqCmd, "stop"],
+    ct:log("Running command ~p", [Cmd]),
+    case rabbit_ct_helpers:exec(Cmd, []) of
+        {ok, _} -> Config;
+        Error   -> ct:pal("Error: ~tp", [Error]),
+                   {skip, "Failed to stop IBM MQ"}
+    end.