[VOL-2597]:
- Create Dockerfile for building docker container with prereq software
for building and running openolt agent UT.
Change-Id: I0f7d244d3253953b8bfe96598047be1f9a6c7b7b
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..626cd61
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,3 @@
+We expect all ONF employees, member companies, and participants to abide by our [Code of Conduct](https://www.opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf).
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns involving someone’s welfare, please notify a member of the ONF team or email [conduct@opennetworking.org](conduct@opennetworking.org).
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c27bac8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,204 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+This project bundles https://github.com/juanchopanza/cppblog/blob/master/Concurrency/Queue/Queue.h
+which is licensed under BSD 2-Clause License.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..3f9866d
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,79 @@
+#Copyright 2018-present Open Networking Foundation
+#
+#Licensed under the Apache License, Version 2.0 (the "License");
+#you may not use this file except in compliance with the License.
+#You may obtain a copy of the License at
+#
+#http://www.apache.org/licenses/LICENSE-2.0
+#
+#Unless required by applicable law or agreed to in writing, software
+#distributed under the License is distributed on an "AS IS" BASIS,
+#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#See the License for the specific language governing permissions and
+#limitations under the License.
+
+########################################################################
+
+# set default shell options
+SHELL = bash -e -o pipefail
+
+## Variables
+VERSION ?= $(shell cat ./VERSION)
+GTEST_VER ?= release-1.8.0
+CMOCK_VER ?= 0207b30
+GMOCK_GLOBAL_VER ?= 1.0.2
+GRPC_VER ?= v1.27.1
+
+# Docker related
+DOCKER_LABEL_VCS_DIRTY = false
+ifneq ($(shell git status --porcelain | grep 'docker/Dockerfile.openolt-test' | wc -l | sed -e 's/ //g'),0)
+ DOCKER_LABEL_VCS_DIRTY = true
+ VERSION = latest
+endif
+
+DOCKER ?= docker
+DOCKER_REGISTRY ?=
+DOCKER_REPOSITORY ?=
+DOCKER_EXTRA_ARGS ?=
+DOCKER_TAG ?= ${VERSION}
+
+OPENOLT_TEST_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}openolt-test:${DOCKER_TAG}
+
+VOLTHA_CI_TOOLS_IMAGENAME := voltha/voltha-ci-tools:1.0.3-hadolint
+
+DOCKER_BUILD_ARGS ?= \
+ ${DOCKER_EXTRA_ARGS} \
+ --build-arg GTEST_VER=${GTEST_VER} \
+ --build-arg CMOCK_VER=${CMOCK_VER} \
+ --build-arg GMOCK_GLOBAL_VER=${GMOCK_GLOBAL_VER} \
+ --build-arg GRPC_VER=${GRPC_VER}
+
+.DEFAULT_GOAL := build
+
+# Builds the docker container with pre-requisite system and test libraries for
+# running openolt agent unit test cases.
+build: docker-build
+
+docker-build: openolt-test
+
+openolt-test:
+ ${DOCKER} build ${DOCKER_BUILD_ARGS} \
+ -t ${OPENOLT_TEST_IMAGENAME} \
+ -f docker/Dockerfile.openolt-test .
+
+docker-push:
+ifneq (false,$(DOCKER_LABEL_VCS_DIRTY))
+ @echo "Local repo is dirty. Refusing to push."
+ @exit 1
+endif
+ ${DOCKER} push ${OPENOLT_TEST_IMAGENAME}
+
+## runnable tool containers
+HADOLINT = ${DOCKER} run --rm --user $$(id -u):$$(id -g) -v $$PWD:/app ${VOLTHA_CI_TOOLS_IMAGENAME} hadolint --ignore DL3003 --ignore DL3015
+
+lint: docker-lint
+
+docker-lint:
+ @echo "Linting Dockerfiles..."
+ @${HADOLINT} $(shell ls docker/Dockerfile.*)
+ @echo "Dockerfiles linted OK"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d59ff9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# openolt-test : Docker container with prereqs for running openolt agent unit tests
+
+This repo contains Dockerfile used to generate docker container with prerequisite software for running openolt agent unit tests.
+
+## Versioning
+
+Final docker images are tagged with the image version from the VERSION file.
+
+The VERSION file should be changed using these rules:
+
+* Bump Patch version if:
+ * Patch version of a tool has changed.
+ * This repo's supporting files have changed (Makefile, readme, etc.) This rule assumes that the containers generated are backwards-compatible; if they are not, bump the major version instead.
+* Bump Minor version if:
+ * Minor version of a tool has changed.
+ * A new tool has been added.
+* Bump Major version if:
+ * Major version of a tool has changed.
+* Bump patch/minor/major version according to semver rules if a Dockerfile is changed.
+* Reset lesser versions if greater versions change.
+* Do not use -dev versions.
+
+## Tool Usage
+
+Only use containers tagged with `<VERSION>`.
+
+Once you are the root folder of the openolt agent repo, execute the below command to build and run the unit tests. Replace `VERSION` to use a specific version of the container.
+
+```shell
+docker run --rm -v $PWD:/app voltha/openolt-test:<VERSION> make test
+```
+
+Details:
+
+* `-v` bind-mounts the local folder into the container.
+
+## Key Commands
+
+* `make build` to build container
+* `make docker-push` to push built container to a registry
+* `make lint` to lint the Dockerfiles
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..3eefcb9
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+1.0.0
diff --git a/docker/Dockerfile.openolt-test b/docker/Dockerfile.openolt-test
new file mode 100644
index 0000000..e25f918
--- /dev/null
+++ b/docker/Dockerfile.openolt-test
@@ -0,0 +1,71 @@
+# Copyright 2020 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:16.04
+
+# Update to have latest images
+RUN apt-get update && apt-get -q -y install \
+ git=1:2.7.4-0ubuntu1.7 \
+ pkg-config=0.29.1-0ubuntu1 \
+ build-essential=12.1ubuntu2 \
+ autoconf=2.69-9 libtool=2.4.6-0.1 \
+ libgflags-dev=2.1.2-3 \
+ clang=1:3.8-33ubuntu3.1 \
+ libc++-dev=3.7.0-1ubuntu0.1 \
+ unzip=6.0-20ubuntu1 \
+ libssl-dev=1.0.2g-1ubuntu4.15 \
+ gawk=1:4.1.3+dfsg-0.1 \
+ debhelper=9.20160115ubuntu3 \
+ dh-systemd=1.29ubuntu4 \
+ init-system-helpers=1.29ubuntu4 \
+ curl=7.47.0-1ubuntu2.14 \
+ cmake=3.5.1-1ubuntu3 \
+ ccache=3.2.4-1 \
+ g++-4.9=4.9.3-13ubuntu2 \
+ wget=1.17.1-1ubuntu1.5 \
+ ca-certificates=20170717~16.04.2 && \
+ apt-get clean && \
+ rm -rf /var/lib/apt/lists/*
+
+ARG GRPC_VER
+# Download, compile and install gRPC. Remove the source and build artificats after install.
+RUN cd /tmp && git clone -b $GRPC_VER https://github.com/grpc/grpc /tmp/grpc && \
+ cd /tmp/grpc && git submodule update --init && \
+ cd /tmp/grpc/third_party/protobuf && ./autogen.sh && ./configure && \
+ make && make install && ldconfig && \
+ cd /tmp/grpc && make && make install && ldconfig && \
+ rm -rf /tmp/grpc
+
+ARG GTEST_VER
+# Download compile and install gtest library. Remove the source and build artificats after install.
+RUN cd /tmp && git clone https://github.com/google/googletest.git && \
+ cd /tmp/googletest && git checkout $GTEST_VER && \
+ cd /tmp/googletest && cmake CMakeLists.txt && \
+ make && make install && ldconfig && \
+ rm -rf /tmp/googletest
+
+ARG CMOCK_VER
+# Download and install C-Mock library. Remove the source and build artificats after install.
+RUN cd /tmp && git clone https://github.com/hjagodzinski/C-Mock.git && \
+ cd /tmp/C-Mock && git checkout $CMOCK_VER && \
+ make install && \
+ rm -rf /tmp/C-Mock
+
+ARG GMOCK_GLOBAL_VER
+# Download and install gmock-global library. Remove the source and build artificats after install.
+RUN cd /tmp && git clone https://github.com/apriorit/gmock-global.git && \
+ cd /tmp/gmock-global && git checkout $GMOCK_GLOBAL_VER && \
+ cp -rf /tmp/gmock-global/include/gmock-global /usr/local/include && rm -rf /tmp/gmock-global
+
+WORKDIR /app