1 #*************************************************************************//**
3 #* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
5 #* Licensed under the Apache License, Version 2.0 (the "License");
6 #* you may not use this file except in compliance with the License.
7 #* You may obtain a copy of the License at
8 #* http://www.apache.org/licenses/LICENSE-2.0
10 #* Unless required by applicable law or agreed to in writing, software
11 #* distributed under the License is distributed on an "AS IS" BASIS,
12 #* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 #* See the License for the specific language governing permissions and
14 #* limitations under the License.
16 #****************************************************************************/
18 #******************************************************************************
19 # The ECOMP Vendor Event Listener (EVEL) API client library Makefile.
21 # Make the various targets associated with housekeeping functions as part of
22 # Event Reporting library.
24 # NOTE: because Makefiles assign special meaning to the TAB character you
25 # will need to set tabstops to 2 characters for the layout to look OK.
26 #****************************************************************************/
28 ARCH=$(shell getconf LONG_BIT)
29 CODE_ROOT=$(CURDIR)/..
30 EVELLIB_ROOT=$(CODE_ROOT)/code/evel_library
31 EVELUNIT_ROOT=$(CODE_ROOT)/code/evel_unit
32 EVELTRAINING_ROOT=$(CODE_ROOT)/code
33 LIBS_DIR=$(CODE_ROOT)/libs/x86_$(ARCH)
34 OUTPUT_DIR=$(CODE_ROOT)/output/x86_$(ARCH)
35 DOCS_ROOT=$(CODE_ROOT)/docs
41 PLANTUML=/usr/local/bin/plantuml.jar
44 #******************************************************************************
45 # Standard compiler flags. *
46 #******************************************************************************
47 CPPFLAGS=-I $(EVELLIB_ROOT)
48 CFLAGS=-Wall -Wextra -m$(ARCH) -g -fPIC
49 LIBCFLAGS=-Wall -Wextra -m$(ARCH) -g -shared -fPIC
51 #******************************************************************************
52 # The testbed is a VM instance where we can install the EVEL example under *
54 #******************************************************************************
55 VNF_TESTBED_CENTOS=172.18.152.180
56 VNF_TESTBED_CENTOS_USER=centos
57 TESTBED_CENTOS_DOWNLOAD_PATH=/home/centos/download/evel_lib
58 TESTBED_CENTOS_INSTALL_PATH=/home/centos/evel
60 #******************************************************************************
61 # The testbed is a VM instance where we can install the EVEL example under *
63 #******************************************************************************
64 VNF_TESTBED_UBUNTU=172.18.152.179
65 VNF_TESTBED_UBUNTU_USER=ubuntu
66 TESTBED_UBUNTU_DOWNLOAD_PATH=/home/ubuntu/Downloads/evel_lib
67 TESTBED_UBUNTU_INSTALL_PATH=/home/ubuntu/evel
69 #******************************************************************************
70 # The test-collector is where we can send events to be consumed and checked *
72 #******************************************************************************
73 VNF_COLLECTOR_HOST=172.18.152.185
74 VNF_COLLECTOR_PORT=30000
76 #******************************************************************************
77 # A documentation server used by the team where we can install documentation. *
78 #******************************************************************************
79 TEAM_DOCS_SERVER=covlx8
80 DOCS_SERVER_PATH=/var/www/html/evel
82 #******************************************************************************
83 # Implicit rule to make dependency files. Recipe copied from Gnu docs at: *
84 # https://www.gnu.org/software/make/manual/html_node/Automatic-Prerequisites.html *
85 #******************************************************************************
87 @echo Making dependency file $(notdir $@) for $(notdir $<)
89 $(CC) -MM -MT $(<:.c=.o) $(CPPFLAGS) $< > $@.$$$$; \
90 sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ > $@; \
93 #******************************************************************************
94 # Implicit rule to make object files. *
95 #******************************************************************************
97 @echo Making $(notdir $@) from $(notdir $<)
98 @$(CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
100 #******************************************************************************
101 # Implicit rule to make diagram files using PlantUML. *
102 #******************************************************************************
104 @echo Making $(notdir $@)
105 $(JAVA) -jar $(PLANTUML) $(PLANTFLAGS) $<
110 clean: api_library_clean \
111 vnf_reporting_clean \
114 install: evel_install_centos evel_install_ubuntu
116 test: evel_test_centos evel_test_ubuntu
118 docs: docs_clean doxygen_docs
121 #******************************************************************************
122 # Build the EVEL libraries. *
123 #******************************************************************************
124 API_SOURCES=$(EVELLIB_ROOT)/evel.c \
125 $(EVELLIB_ROOT)/metadata.c \
126 $(EVELLIB_ROOT)/ring_buffer.c \
127 $(EVELLIB_ROOT)/double_list.c \
128 $(EVELLIB_ROOT)/hashtable.c \
129 $(EVELLIB_ROOT)/evel_event.c \
130 $(EVELLIB_ROOT)/evel_fault.c \
131 $(EVELLIB_ROOT)/evel_mobile_flow.c \
132 $(EVELLIB_ROOT)/evel_option.c \
133 $(EVELLIB_ROOT)/evel_jsonobject.c \
134 $(EVELLIB_ROOT)/evel_other.c \
135 $(EVELLIB_ROOT)/evel_json_buffer.c \
136 $(EVELLIB_ROOT)/evel_reporting_measurement.c \
137 $(EVELLIB_ROOT)/evel_heartbeat_fields.c \
138 $(EVELLIB_ROOT)/evel_sipsignaling.c \
139 $(EVELLIB_ROOT)/evel_scaling_measurement.c \
140 $(EVELLIB_ROOT)/evel_state_change.c \
141 $(EVELLIB_ROOT)/evel_strings.c \
142 $(EVELLIB_ROOT)/evel_syslog.c \
143 $(EVELLIB_ROOT)/evel_throttle.c \
144 $(EVELLIB_ROOT)/evel_internal_event.c \
145 $(EVELLIB_ROOT)/evel_event_mgr.c \
146 $(EVELLIB_ROOT)/evel_threshold_cross.c \
147 $(EVELLIB_ROOT)/evel_voicequality.c \
148 $(EVELLIB_ROOT)/evel_logging.c \
149 $(EVELLIB_ROOT)/jsmn.c
150 API_OBJECTS=$(API_SOURCES:.c=.o)
151 -include $(API_SOURCES:.c=.d)
153 api_library: $(LIBS_DIR)/libevel.so \
154 $(LIBS_DIR)/libevel.a
156 $(LIBS_DIR)/libevel.a: $(API_OBJECTS)
157 @echo Linking API Static Library
158 @$(CC) $(LIBCFLAGS) -o $@ $+
160 $(LIBS_DIR)/libevel.so: $(API_OBJECTS)
161 @echo Linking API Shared Library
162 @$(CC) $(LIBCFLAGS) -L $(QLIBCLIBSDIR) -lqlibc -o $@ $+
165 @echo Cleaning API Library
166 @$(RM) $(LIBS_DIR)/libevel.so
167 @$(RM) $(API_OBJECTS)
168 @$(RM) $(EVELLIB_ROOT)/*.d
170 #******************************************************************************
171 # Build the EVEL library unit test. *
172 #******************************************************************************
173 UNIT_SOURCES=$(EVELUNIT_ROOT)/evel_unit.c
174 UNIT_OBJECTS=$(UNIT_SOURCES:.c=.o)
175 -include $(UNIT_SOURCES:.c=.d)
177 evel_unit: api_library \
178 $(OUTPUT_DIR)/evel_unit
180 $(OUTPUT_DIR)/evel_unit: $(UNIT_OBJECTS)
181 @echo Linking EVEL unit test
182 $(CC) $(CPPFLAGS) $(CFLAGS) -o $@ \
190 @echo Cleaning EVEL unit test
191 @$(RM) $(OUTPUT_DIR)/evel_unit
192 @$(RM) $(API_OBJECTS)
193 @$(RM) $(UNIT_OBJECTS)
194 @$(RM) $(EVELLIB_ROOT)/*.d
195 @$(RM) $(EVELUNIT_ROOT)/*.d
197 #******************************************************************************
198 # Build the VNF VES Reporting code *
199 #******************************************************************************
201 @echo Making VNF Reporting
202 @$(MAKE) -s -C $(EVELTRAINING_ROOT)/VESreporting
205 @echo Cleaning VNF Reporting
206 @$(RM) $(EVELTRAINING_ROOT)/VESreporting/vpp_measurement_reporter
208 #******************************************************************************
209 # Copy the EVEL demo onto the CentOS testbed as a package and build it. *
210 #******************************************************************************
211 evel_install_centos: delivery
212 @echo Installing EVEL library on CentOS testbed...
213 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
214 rm -rf $(TESTBED_CENTOS_DOWNLOAD_PATH) \; \
215 mkdir -p $(TESTBED_CENTOS_DOWNLOAD_PATH) \; \
216 mkdir -p $(TESTBED_CENTOS_INSTALL_PATH)
217 @$(SCP) -r $(CODE_ROOT)/output/evel-library-package.tgz \
218 $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS):$(TESTBED_CENTOS_DOWNLOAD_PATH)
219 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
220 tar zx --directory $(TESTBED_CENTOS_INSTALL_PATH) \
221 --file $(TESTBED_CENTOS_DOWNLOAD_PATH)/evel-library-package.tgz
222 @echo Making EVEL library on testbed...
223 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
224 cd $(TESTBED_CENTOS_INSTALL_PATH)/bldjobs \; \
227 #******************************************************************************
228 # Copy the EVEL demo onto the Ubuntu testbed as a package and build it. *
229 #******************************************************************************
230 evel_install_ubuntu: delivery
231 @echo Installing EVEL library on Ubuntu testbed...
232 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
233 rm -rf $(TESTBED_UBUNTU_DOWNLOAD_PATH) \; \
234 mkdir -p $(TESTBED_UBUNTU_DOWNLOAD_PATH) \; \
235 mkdir -p $(TESTBED_UBUNTU_INSTALL_PATH)
236 @$(SCP) -r $(CODE_ROOT)/output/evel-library-package.tgz \
237 $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU):$(TESTBED_UBUNTU_DOWNLOAD_PATH)
238 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
239 tar zx --directory $(TESTBED_UBUNTU_INSTALL_PATH) \
240 --file $(TESTBED_UBUNTU_DOWNLOAD_PATH)/evel-library-package.tgz
241 @echo Making EVEL library on testbed...
242 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
243 cd $(TESTBED_UBUNTU_INSTALL_PATH)/bldjobs \; \
246 #******************************************************************************
247 # Make sure that the Centos platform is up to date and then run the software *
248 # against a test collector. Validating correct operation is not presently *
250 #******************************************************************************
251 evel_test_centos: evel_install_centos
252 @echo Testing EVEL Demo application on CentOS...
253 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
254 source .bash_profile \; \
255 $(TESTBED_CENTOS_INSTALL_PATH)/output/x86_$(ARCH)/evel_demo \
256 --fqdn $(VNF_COLLECTOR_HOST) \
257 --port $(VNF_COLLECTOR_PORT) \
260 #******************************************************************************
261 # Make sure that the Ubuntu platform is up to date and then run the software *
262 # against a test collector. Validating correct operation is not presently *
264 #******************************************************************************
265 evel_test_ubuntu: evel_install_ubuntu
266 @echo Testing EVEL Demo application on Ubuntu...
267 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
269 $(TESTBED_UBUNTU_INSTALL_PATH)/output/x86_$(ARCH)/evel_demo \
270 --fqdn $(VNF_COLLECTOR_HOST) \
271 --port $(VNF_COLLECTOR_PORT) \
274 #******************************************************************************
275 # Making a clean delivery has some very specific dependencies which are order *
276 # dependent, so we recursively make a series of targets to do a clean build *
277 # of all of the required deliverables and then finally zipping up. *
278 #******************************************************************************
280 @$(MAKE) -s delivery_baseline
283 delivery_baseline: docs
285 #******************************************************************************
286 # Package the software for delivery. *
287 #******************************************************************************
288 package: api_library_clean \
290 @echo Packaging the software for delivery
291 @cd $(CODE_ROOT) && tar cfz output/evel-library-package.tgz bldjobs \
295 output/x86_64/README \
299 @echo Clean delivery packages
300 @$(RM) $(OUTPUTDIR)/*.tgz