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 MACHINE_ARCH=$(shell uname -m)
30 CODE_ROOT=$(CURDIR)/..
31 EVELLIB_ROOT=$(CODE_ROOT)/code/evel_library
32 EVELUNIT_ROOT=$(CODE_ROOT)/code/evel_unit
33 EVELTRAINING_ROOT=$(CODE_ROOT)/code
34 LIBS_DIR=$(CODE_ROOT)/libs/$(MACHINE_ARCH)
35 OUTPUT_DIR=$(CODE_ROOT)/output/$(MACHINE_ARCH)
36 DOCS_ROOT=$(CODE_ROOT)/docs
42 PLANTUML=/usr/local/bin/plantuml.jar
45 #******************************************************************************
46 # Standard compiler flags. *
47 #******************************************************************************
48 CPPFLAGS=-I $(EVELLIB_ROOT)
49 ifeq ($(MACHINE_ARCH), aarch64)
50 CFLAGS=-Wall -Wextra -march=native -g -fPIC
51 LIBCFLAGS=-Wall -Wextra -march=native -g -shared -fPIC
53 CFLAGS=-Wall -Wextra -m$(ARCH) -g -fPIC
54 LIBCFLAGS=-Wall -Wextra -m$(ARCH) -g -shared -fPIC
57 #******************************************************************************
58 # The testbed is a VM instance where we can install the EVEL example under *
60 #******************************************************************************
61 VNF_TESTBED_CENTOS=172.18.152.180
62 VNF_TESTBED_CENTOS_USER=centos
63 TESTBED_CENTOS_DOWNLOAD_PATH=/home/centos/download/evel_lib
64 TESTBED_CENTOS_INSTALL_PATH=/home/centos/evel
66 #******************************************************************************
67 # The testbed is a VM instance where we can install the EVEL example under *
69 #******************************************************************************
70 VNF_TESTBED_UBUNTU=172.18.152.179
71 VNF_TESTBED_UBUNTU_USER=ubuntu
72 TESTBED_UBUNTU_DOWNLOAD_PATH=/home/ubuntu/Downloads/evel_lib
73 TESTBED_UBUNTU_INSTALL_PATH=/home/ubuntu/evel
75 #******************************************************************************
76 # The test-collector is where we can send events to be consumed and checked *
78 #******************************************************************************
79 VNF_COLLECTOR_HOST=172.18.152.185
80 VNF_COLLECTOR_PORT=30000
82 #******************************************************************************
83 # A documentation server used by the team where we can install documentation. *
84 #******************************************************************************
85 TEAM_DOCS_SERVER=covlx8
86 DOCS_SERVER_PATH=/var/www/html/evel
88 #******************************************************************************
89 # Implicit rule to make dependency files. Recipe copied from Gnu docs at: *
90 # https://www.gnu.org/software/make/manual/html_node/Automatic-Prerequisites.html *
91 #******************************************************************************
93 @echo Making dependency file $(notdir $@) for $(notdir $<)
95 $(CC) -MM -MT $(<:.c=.o) $(CPPFLAGS) $< > $@.$$$$; \
96 sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ > $@; \
99 #******************************************************************************
100 # Implicit rule to make object files. *
101 #******************************************************************************
103 @echo Making $(notdir $@) from $(notdir $<)
104 @$(CC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
106 #******************************************************************************
107 # Implicit rule to make diagram files using PlantUML. *
108 #******************************************************************************
110 @echo Making $(notdir $@)
111 $(JAVA) -jar $(PLANTUML) $(PLANTFLAGS) $<
117 clean: api_library_clean \
120 install: evel_install_centos evel_install_ubuntu
122 test: evel_test_centos evel_test_ubuntu
124 docs: docs_clean doxygen_docs
127 #******************************************************************************
128 # Build the EVEL libraries. *
129 #******************************************************************************
130 API_SOURCES=$(EVELLIB_ROOT)/evel.c \
131 $(EVELLIB_ROOT)/metadata.c \
132 $(EVELLIB_ROOT)/ring_buffer.c \
133 $(EVELLIB_ROOT)/double_list.c \
134 $(EVELLIB_ROOT)/hashtable.c \
135 $(EVELLIB_ROOT)/evel_event.c \
136 $(EVELLIB_ROOT)/evel_fault.c \
137 $(EVELLIB_ROOT)/evel_mobile_flow.c \
138 $(EVELLIB_ROOT)/evel_option.c \
139 $(EVELLIB_ROOT)/evel_jsonobject.c \
140 $(EVELLIB_ROOT)/evel_other.c \
141 $(EVELLIB_ROOT)/evel_json_buffer.c \
142 $(EVELLIB_ROOT)/evel_reporting_measurement.c \
143 $(EVELLIB_ROOT)/evel_heartbeat_fields.c \
144 $(EVELLIB_ROOT)/evel_sipsignaling.c \
145 $(EVELLIB_ROOT)/evel_scaling_measurement.c \
146 $(EVELLIB_ROOT)/evel_state_change.c \
147 $(EVELLIB_ROOT)/evel_strings.c \
148 $(EVELLIB_ROOT)/evel_syslog.c \
149 $(EVELLIB_ROOT)/evel_throttle.c \
150 $(EVELLIB_ROOT)/evel_internal_event.c \
151 $(EVELLIB_ROOT)/evel_event_mgr.c \
152 $(EVELLIB_ROOT)/evel_threshold_cross.c \
153 $(EVELLIB_ROOT)/evel_voicequality.c \
154 $(EVELLIB_ROOT)/evel_logging.c \
155 $(EVELLIB_ROOT)/evel_batch.c \
156 $(EVELLIB_ROOT)/jsmn.c
157 API_OBJECTS=$(API_SOURCES:.c=.o)
158 -include $(API_SOURCES:.c=.d)
160 api_library: $(LIBS_DIR)/libevel.so \
161 $(LIBS_DIR)/libevel.a
163 $(LIBS_DIR)/libevel.a: $(API_OBJECTS)
164 @echo Linking API Static Library
165 @$(CC) $(LIBCFLAGS) -o $@ $+
167 $(LIBS_DIR)/libevel.so: $(API_OBJECTS)
168 @echo Linking API Shared Library
169 @$(CC) $(LIBCFLAGS) -L $(QLIBCLIBSDIR) -lqlibc -o $@ $+
172 @echo Cleaning API Library
173 @$(RM) $(LIBS_DIR)/libevel.so
174 @$(RM) $(API_OBJECTS)
175 @$(RM) $(EVELLIB_ROOT)/*.d
177 #******************************************************************************
178 # Build the EVEL library unit test. *
179 #******************************************************************************
180 UNIT_SOURCES=$(EVELUNIT_ROOT)/evel_unit.c
181 UNIT_OBJECTS=$(UNIT_SOURCES:.c=.o)
182 -include $(UNIT_SOURCES:.c=.d)
184 evel_unit: api_library \
185 $(OUTPUT_DIR)/evel_unit
187 $(OUTPUT_DIR)/evel_unit: $(UNIT_OBJECTS)
188 @echo Linking EVEL unit test
189 $(CC) $(CPPFLAGS) $(CFLAGS) -o $@ \
197 @echo Cleaning EVEL unit test
198 @$(RM) $(OUTPUT_DIR)/evel_unit
199 @$(RM) $(API_OBJECTS)
200 @$(RM) $(UNIT_OBJECTS)
201 @$(RM) $(EVELLIB_ROOT)/*.d
202 @$(RM) $(EVELUNIT_ROOT)/*.d
205 #******************************************************************************
206 # Copy the EVEL demo onto the CentOS testbed as a package and build it. *
207 #******************************************************************************
208 evel_install_centos: delivery
209 @echo Installing EVEL library on CentOS testbed...
210 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
211 rm -rf $(TESTBED_CENTOS_DOWNLOAD_PATH) \; \
212 mkdir -p $(TESTBED_CENTOS_DOWNLOAD_PATH) \; \
213 mkdir -p $(TESTBED_CENTOS_INSTALL_PATH)
214 @$(SCP) -r $(CODE_ROOT)/output/evel-library-package.tgz \
215 $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS):$(TESTBED_CENTOS_DOWNLOAD_PATH)
216 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
217 tar zx --directory $(TESTBED_CENTOS_INSTALL_PATH) \
218 --file $(TESTBED_CENTOS_DOWNLOAD_PATH)/evel-library-package.tgz
219 @echo Making EVEL library on testbed...
220 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
221 cd $(TESTBED_CENTOS_INSTALL_PATH)/bldjobs \; \
224 #******************************************************************************
225 # Copy the EVEL demo onto the Ubuntu testbed as a package and build it. *
226 #******************************************************************************
227 evel_install_ubuntu: delivery
228 @echo Installing EVEL library on Ubuntu testbed...
229 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
230 rm -rf $(TESTBED_UBUNTU_DOWNLOAD_PATH) \; \
231 mkdir -p $(TESTBED_UBUNTU_DOWNLOAD_PATH) \; \
232 mkdir -p $(TESTBED_UBUNTU_INSTALL_PATH)
233 @$(SCP) -r $(CODE_ROOT)/output/evel-library-package.tgz \
234 $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU):$(TESTBED_UBUNTU_DOWNLOAD_PATH)
235 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
236 tar zx --directory $(TESTBED_UBUNTU_INSTALL_PATH) \
237 --file $(TESTBED_UBUNTU_DOWNLOAD_PATH)/evel-library-package.tgz
238 @echo Making EVEL library on testbed...
239 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
240 cd $(TESTBED_UBUNTU_INSTALL_PATH)/bldjobs \; \
243 #******************************************************************************
244 # Make sure that the Centos platform is up to date and then run the software *
245 # against a test collector. Validating correct operation is not presently *
247 #******************************************************************************
248 evel_test_centos: evel_install_centos
249 @echo Testing EVEL Demo application on CentOS...
250 @$(SSH) $(VNF_TESTBED_CENTOS_USER)@$(VNF_TESTBED_CENTOS) \
251 source .bash_profile \; \
252 $(TESTBED_CENTOS_INSTALL_PATH)/output/$(MACHINE_ARCH)/evel_demo \
253 --fqdn $(VNF_COLLECTOR_HOST) \
254 --port $(VNF_COLLECTOR_PORT) \
257 #******************************************************************************
258 # Make sure that the Ubuntu platform is up to date and then run the software *
259 # against a test collector. Validating correct operation is not presently *
261 #******************************************************************************
262 evel_test_ubuntu: evel_install_ubuntu
263 @echo Testing EVEL Demo application on Ubuntu...
264 @$(SSH) $(VNF_TESTBED_UBUNTU_USER)@$(VNF_TESTBED_UBUNTU) \
266 $(TESTBED_UBUNTU_INSTALL_PATH)/output/$(MACHINE_ARCH)/evel_demo \
267 --fqdn $(VNF_COLLECTOR_HOST) \
268 --port $(VNF_COLLECTOR_PORT) \
271 #******************************************************************************
272 # Making a clean delivery has some very specific dependencies which are order *
273 # dependent, so we recursively make a series of targets to do a clean build *
274 # of all of the required deliverables and then finally zipping up. *
275 #******************************************************************************
277 @$(MAKE) -s delivery_baseline
280 delivery_baseline: docs
282 #******************************************************************************
283 # Package the software for delivery. *
284 #******************************************************************************
285 package: api_library_clean \
287 @echo Packaging the software for delivery
288 @cd $(CODE_ROOT) && tar cfz output/evel-library-package.tgz bldjobs \
291 libs/$(MACHINE_ARCH)/README \
292 output/$(MACHINE_ARCH)/README \
296 @echo Clean delivery packages
297 @$(RM) $(OUTPUTDIR)/*.tgz