Skip to content

Commit

Permalink
Fixed #139: Rename all artifacts to avoid collisions with Qpid Dispatch
Browse files Browse the repository at this point in the history
This renames all executables, paths, and other installables to use
skupper oriented names. Management entity identifiers have also been
changed to use "io.skupper" prefix.
  • Loading branch information
kgiusti committed Mar 16, 2022
1 parent 1f9e1da commit 662be06
Show file tree
Hide file tree
Showing 134 changed files with 1,002 additions and 1,003 deletions.
10 changes: 5 additions & 5 deletions .github/scripts/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ WORKDIR /
COPY --from=builder /qpid-proton-image.tar.gz /skupper-router-image.tar.gz /
RUN tar zxpf qpid-proton-image.tar.gz && tar zxpf skupper-router-image.tar.gz && rm -f /qpid-proton-image.tar.gz /skupper-router-image.tar.gz

WORKDIR /home/qdrouterd/etc
WORKDIR /home/qdrouterd/bin
COPY ./scripts/* /home/qdrouterd/bin/
WORKDIR /home/skrouterd/etc
WORKDIR /home/skrouterd/bin
COPY ./scripts/* /home/skrouterd/bin/

ARG version=latest
ENV VERSION=${version}
ENV QDROUTERD_HOME=/home/qdrouterd
ENV QDROUTERD_HOME=/home/skrouterd

EXPOSE 5672 55672 5671
CMD ["/home/qdrouterd/bin/launch.sh"]
CMD ["/home/skrouterd/bin/launch.sh"]
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ jobs:
- name: Create Build and Install directories
run: mkdir -p "${DispatchBuildDir}" "{InstallPrefix}"

- name: qpid-dispatch cmake configure
- name: skupper-router cmake configure
working-directory: ${{env.DispatchBuildDir}}
run: >
cmake "${{github.workspace}}" \
Expand Down
25 changes: 11 additions & 14 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
##

cmake_minimum_required(VERSION 3.20)
project(qpid-dispatch C CXX)
project(skupper-router C CXX)

set(CMAKE_C_STANDARD 11)
set(CMAKE_C_STANDARD_REQUIRED ON)
Expand Down Expand Up @@ -115,14 +115,14 @@ if (NOT DEFINED LIB_SUFFIX)
endif()

set(INCLUDE_INSTALL_DIR include CACHE PATH "Include file directory")
set(QPID_DISPATCH_HOME "lib/qpid-dispatch" CACHE PATH "Private Dispatch library directory")
set(QPID_DISPATCH_HOME "lib/skupper-router" CACHE PATH "Private Skupper library directory")
set(LIB_INSTALL_DIR "lib${LIB_SUFFIX}" CACHE PATH "Library object file directory")
set(SHARE_INSTALL_DIR share CACHE PATH "Shared read only data directory")
set(DOC_INSTALL_DIR ${SHARE_INSTALL_DIR}/doc CACHE PATH "Documentation directory")
set(QD_DOC_INSTALL_DIR ${SHARE_INSTALL_DIR}/doc/qpid-dispatch CACHE PATH "Qpid Dispatch documentation directory")
set(QD_DOC_INSTALL_DIR ${SHARE_INSTALL_DIR}/doc/skupper-router CACHE PATH "Skupper Router documentation directory")
set(MAN_INSTALL_DIR share/man CACHE PATH "Manpage directory")
set(QPID_DISPATCH_HOME_INSTALLED ${CMAKE_INSTALL_PREFIX}/${QPID_DISPATCH_HOME})
set(QPID_DISPATCH_HTML_DIR ${CMAKE_INSTALL_PREFIX}/share/qpid-dispatch/html CACHE PATH "Qpid Dispatch HTML directory")
set(QPID_DISPATCH_HTML_DIR ${CMAKE_INSTALL_PREFIX}/share/skupper-router/html CACHE PATH "Skupper Router HTML directory")

set(RUN ${Python_EXECUTABLE} ${CMAKE_BINARY_DIR}/run.py)

Expand All @@ -135,7 +135,7 @@ if(NOT DEFINED SYSCONF_INSTALL_DIR)
endif()
endif()

set(QPID_DISPATCH_CONFDIR ${SYSCONF_INSTALL_DIR}/qpid-dispatch)
set(QPID_DISPATCH_CONFDIR ${SYSCONF_INSTALL_DIR}/skupper-router)

# Set up runtime checks (valgrind, sanitizers etc.)
include(cmake/RuntimeChecks.cmake)
Expand Down Expand Up @@ -197,20 +197,17 @@ if (CMAKE_BUILD_TYPE MATCHES "Coverage")
endif(CMAKE_BUILD_TYPE MATCHES "Coverage")

##
## Header file installation
## configuration/html file installation
##
file(GLOB headers "include/qpid/dispatch/*.h")
install(FILES ${headers} DESTINATION ${INCLUDE_INSTALL_DIR}/qpid/dispatch)
install(FILES include/qpid/dispatch.h DESTINATION ${INCLUDE_INSTALL_DIR}/qpid)
install(FILES etc/qdrouterd.conf DESTINATION ${SYSCONF_INSTALL_DIR}/qpid-dispatch)
install(FILES etc/sasl2/qdrouterd.conf DESTINATION ${SYSCONF_INSTALL_DIR}/sasl2)
install(FILES etc/skrouterd.conf DESTINATION ${SYSCONF_INSTALL_DIR}/skupper-router)
install(FILES etc/sasl2/skrouterd.conf DESTINATION ${SYSCONF_INSTALL_DIR}/sasl2)
install(FILES share/index.html DESTINATION ${QPID_DISPATCH_HTML_DIR})


# Tools
install(PROGRAMS
${CMAKE_CURRENT_SOURCE_DIR}/tools/qdstat
${CMAKE_CURRENT_SOURCE_DIR}/tools/qdmanage
${CMAKE_CURRENT_SOURCE_DIR}/tools/skstat
${CMAKE_CURRENT_SOURCE_DIR}/tools/skmanage
DESTINATION bin)

# Doc files
Expand All @@ -223,7 +220,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/run.py.in ${CMAKE_CURRENT_BINARY_DIR}
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/run.py.in ${CMAKE_CURRENT_BINARY_DIR}/tests/run.py)
execute_process(COMMAND ${RUN} --sh OUTPUT_FILE config.sh)

add_subdirectory(src) # Build src first so other subdirs can use qpid-dispatch library
add_subdirectory(src) # Build src first so other subdirs can use library

if (NOT UNITTEST_MISSING)
file(GLOB SCRAPER_SRC ${CMAKE_CURRENT_SOURCE_DIR}/tools/scraper/*.py)
Expand Down
8 changes: 4 additions & 4 deletions bin/export.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@

# run this script like this -
# Before executing this script, change directory to the folder in which this file is located, for example.
# 1. cd /home/jdoe/qpid-dispatch/bin
# 1. cd /home/jdoe/skupper-router/bin
# Run the script like so -
# 2. ./export.sh <output_folder-full-path> <tag-name>
# (Example : ./export.sh /home/jdoe/ 1.5.1
# (/home/jdoe is the folder you want the tar.gz file to be put - specify the full path)
# 1.5.1 is the tag name
# A file named qpid-dispatch-<tag-name>.tar.gz will be created at <output_folder-full-path>
# A file named skupper-router-<tag-name>.tar.gz will be created at <output_folder-full-path>

# Simply running ./export.sh will put the tar.gz file in the current folder and use the very latest createed tag

Expand Down Expand Up @@ -90,8 +90,8 @@ echo Working Directory=${WORKDIR}
cd ${SRC}
MTIME=$(date -d @`git log -1 --pretty=format:%ct tags/${TAG}` '+%Y-%m-%d %H:%M:%S')
VERSION=$(git show tags/${TAG}:VERSION.txt)
ARCHIVE=$DIR/qpid-dispatch-${VERSION}.tar.gz
PREFIX=qpid-dispatch-${VERSION}
ARCHIVE=$DIR/skupper-router-${VERSION}.tar.gz
PREFIX=skupper-router-${VERSION}
[ -d ${WORKDIR} ] || mkdir -p ${WORKDIR}
git archive --format=tar --prefix=${PREFIX}/ tags/${TAG} \
| tar -x -C ${WORKDIR}
Expand Down
2 changes: 1 addition & 1 deletion bin/grinder
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ def parse_error(error_xml):
" to handle it" % kind)


def parse_xml_file(filename, exe_name='qdrouterd'):
def parse_xml_file(filename, exe_name='skrouterd'):
"""
Parse out errors from a valgrind output xml file
"""
Expand Down
2 changes: 1 addition & 1 deletion bin/test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ make -j4
ctest -VV ${DISPATCH_CTEST_EXTRA_ARGS}
# Run system tests on the install.
make install
python $INSTALL_DIR/lib/qpid-dispatch/tests/run_system_tests.py
python $INSTALL_DIR/lib/skupper-router/tests/run_system_tests.py
4 changes: 2 additions & 2 deletions dockerfiles/Dockerfile-centos7
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ RUN cmake .. -DCMAKE_INSTALL_PREFIX=/usr && make install
# Uncomment the following line if you would like to run all the dispatch unit tests and system tests.
# RUN ctest -VV

# Start the dispatch router
#ENTRYPOINT ["qdrouterd"]
# Start the skupper router
#ENTRYPOINT ["skrouterd"]
CMD ["/bin/bash"]
4 changes: 2 additions & 2 deletions dockerfiles/Dockerfile-fedora
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ RUN cmake .. -DCMAKE_INSTALL_PREFIX=/usr && make install
# Uncomment the following line if you would like to run all the dispatch unit tests and system tests.
# RUN ctest -VV

# Start the dispatch router
ENTRYPOINT ["qdrouterd"]
# Start the skupper router
ENTRYPOINT ["skrouterd"]
#CMD ["/bin/bash"]
4 changes: 2 additions & 2 deletions dockerfiles/Dockerfile-ubuntu
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ ENV PYTHONPATH=/usr/lib/python2.7/site-packages

WORKDIR /qpid-dispatch

# Start the dispatch router
ENTRYPOINT ["qdrouterd"]
# Start the skupper router
ENTRYPOINT ["skrouterd"]
#CMD ["/bin/bash"]
16 changes: 8 additions & 8 deletions docs/man/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
set (src ${CMAKE_CURRENT_SOURCE_DIR})
set (bin ${CMAKE_CURRENT_BINARY_DIR})
set (tools ${CMAKE_SOURCE_DIR}/tools)
set (schema ../../python/qpid_dispatch/management/qdrouter.json)
set (py_management ../../python/qpid_dispatch_internal/management)
set (schema ../../python/skupper_router/management/skrouter.json)
set (py_management ../../python/skupper_router_internal/management)
set (schema_deps ${schema} ${py_management}/schema_doc.py ${py_management}/schema.py)

# Flags for doc tools, based on cmake options
Expand All @@ -47,7 +47,7 @@ macro (schema_gen script output)
list (APPEND generated_txt "${output}")
endmacro ()

schema_gen (${src}/qdrouterd.conf.5.py ${bin}/qdrouterd.conf.5.adoc)
schema_gen (${src}/skrouterd.conf.5.py ${bin}/skrouterd.conf.5.adoc)

# Generate asciidoc .adoc from --help output for man pages
macro (help2txt program)
Expand All @@ -61,9 +61,9 @@ macro (help2txt program)
list (APPEND generated_txt "${output}")
endmacro ()

help2txt (${CMAKE_BINARY_DIR}/router/qdrouterd)
help2txt (${tools}/qdmanage)
help2txt (${tools}/qdstat)
help2txt (${CMAKE_BINARY_DIR}/router/skrouterd)
help2txt (${tools}/skmanage)
help2txt (${tools}/skstat)

add_custom_target (doc_gen DEPENDS ${generated_txt})

Expand All @@ -74,7 +74,7 @@ if (ASCIIDOC_EXE)

# Generate HTML
file (GLOB_RECURSE adoc_files *.adoc)
foreach (source ${src}/qdmanage.8 ${src}/qdrouterd.8 ${src}/qdstat.8 ${bin}/qdrouterd.conf.5)
foreach (source ${src}/skmanage.8 ${src}/skrouterd.8 ${src}/skstat.8 ${bin}/skrouterd.conf.5)
get_filename_component (name ${source} NAME)
string(FIND ${name} "." dot)
if (dot GREATER 0)
Expand All @@ -98,7 +98,7 @@ if (ASCIIDOC_EXE)
find_program(A2X_EXE a2x DOC DOC "Generate Unix man pages")
if (A2X_EXE)
# Generate man pages.
foreach (source ${src}/qdmanage.8 ${src}/qdrouterd.8 ${src}/qdstat.8 ${bin}/qdrouterd.conf.5)
foreach (source ${src}/skmanage.8 ${src}/skrouterd.8 ${src}/skstat.8 ${bin}/skrouterd.conf.5)
get_filename_component (name ${source} NAME)
string(REGEX REPLACE ".*\\.([0-9])$" "\\1" section ${source}) # Man section number
set (output ${bin}/${name})
Expand Down
34 changes: 17 additions & 17 deletions docs/man/qdmanage.8.adoc → docs/man/skmanage.8.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,30 @@ specific language governing permissions and limitations
under the License
////
qdmanage(8)
skmanage(8)
==========
:doctype: manpage
NAME
----
qdmanage - management client to control or query qdrouterd(8)
skmanage - management client to control or query skupper-router
SYNOPSIS
--------
*qdmanage* ['OPTIONS'] 'OPERATION' ['ARGUMENTS']
*skmanage* ['OPTIONS'] 'OPERATION' ['ARGUMENTS']
DESCRIPTION
-----------
An AMQP management client for use with the Dispatch router daemon
('qdrouterd'). Sends AMQP management operations requests and prints
An AMQP management client for use with the skupper-router daemon
('skrouterd'). Sends AMQP management operations requests and prints
the response in JSON format. This is a generic AMQP management tool
and can be used with any AMQP endpoint that follows the AMQP Management
specification, not just with 'qdrouterd'.
specification, not just with 'skrouterd'.
OPTIONS
-------
include::{generated_man}/qdmanage_help.adoc[]
include::{generated_man}/skmanage_help.adoc[]
OPERATIONS
----------
Expand Down Expand Up @@ -99,41 +99,41 @@ OPERATIONS
FILES
-----
{CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/qdrouter.json::
Management schema for 'qdrouterd'.
{CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/qdrouter.json.readme.txt::
{CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/skrouter.json::
Management schema for 'skrouterd'.
{CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/skrouter.json.readme.txt::
Explanation of the management schema.
EXAMPLES
--------
.Show the logging configuration:
--------------------------------------------------------------
qdmanage query --type=log
skmanage query --type=log
--------------------------------------------------------------
.Enable debug and higher log messages by default:
--------------------------------------------------------------
qdmanage update name=log/DEFAULT enable=debug+
skmanage update name=log/DEFAULT enable=debug+
--------------------------------------------------------------
.Enable trace log messages only for the MESSAGE module, and direct MESSAGE logs to the file _test.log_:
--------------------------------------------------------------
qdmanage update name=log/MESSAGE enable=trace output=test.log
skmanage update name=log/MESSAGE enable=trace output=test.log
--------------------------------------------------------------
.Set MESSAGE logging back to the default:
------------------------------------------------
qdmanage update name=log/MESSAGE enable=default
skmanage update name=log/MESSAGE enable=default
------------------------------------------------
.Disable MESSAGE logging:
---------------------------------------------
qdmanage update name=log/MESSAGE enable=none
skmanage update name=log/MESSAGE enable=none
---------------------------------------------
SEE ALSO
----------
'qdrouterd(8)', 'qdstat(8)', 'qdrouterd.conf(5)'
'skrouterd(8)', 'skstat(8)', 'skrouterd.conf(5)'
http://qpid.apache.org/components/dispatch-router
https://github.com/skupperproject/skupper-router
16 changes: 8 additions & 8 deletions docs/man/qdrouterd.8.adoc → docs/man/skrouterd.8.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,38 @@ specific language governing permissions and limitations
under the License
////
qdrouterd(8)
skrouterd(8)
===========
:doctype: manpage
NAME
----
qdrouterd - routes AMQP messages.
skrouterd - routes AMQP messages.
SYNOPSIS
--------
*qdrouterd* ['OPTIONS']
*skrouterd* ['OPTIONS']
DESCRIPTION
-----------
The Qpid Dispatch router ('qdrouterd') is a network daemon that directs
The skupper router ('skrouterd') is a network daemon that directs
AMQP 1.0 messages between endpoints, such as messaging clients and
servers.
OPTIONS
-------
include::{generated_man}/qdrouterd_help.adoc[]
include::{generated_man}/skrouterd_help.adoc[]
FILES
-----
{SYSCONF_INSTALL_DIR}/qdrouterd.conf::
{SYSCONF_INSTALL_DIR}/skrouterd.conf::
Configuration file.
SEE ALSO
--------
'qdrouterd.conf(5)', 'qdstat(8)', 'qdmanage(8)'
'skrouterd.conf(5)', 'skstat(8)', 'skmanage(8)'
http://qpid.apache.org/components/dispatch-router
https://github.com/skupperproject/skupper-router
Loading

0 comments on commit 662be06

Please sign in to comment.