[VOL-5358] - build & test repo using new AMI image

makefiles/docker/include.mk
---------------------------
  o get-cmd-docker-protoc-sh()
  o Initial get-cmd() function required one path -v <mount> or --workdir.
  o repo:voltha-protos requires multiple docker mounts so add a second
    get-cmd() function that will accept a list of arguments/mounts.
  o Makefile can override the definition of PROTOC_SH and GO_SH.
  o Purge stray comments copied in as a placeholder from a repo Makefile,
    can add these individually as needed.
  o [TODO] Consider moving get-cmd() logic into named docker makefiles
    if more functions are needed.

makefiles/virtualenv/requirements-txt.mk
----------------------------------------
  o This was cute: user .bashrc, env can bleed through affecting python
    module config and compiler flag selection.
  o When installing packages using requirements.txt, sanitize the shell
    to avoid stray interaction with user defined environment.
  o In my case compiling would fail while attempting to construct a wheel
    for packages being installed.

Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Id1492807a505e54348b95bd553877565b55c57f6
2 files changed
tree: 2299d8a45d70bb75743956aa9799804ae0924b0b
  1. .gitignore
  2. .gitreview
  3. .pre-commit-config.yaml
  4. .reuse/
  5. LICENSES/
  6. Makefile
  7. README.md
  8. bin/
  9. config.mk
  10. docs/
  11. install/
  12. makefiles/
  13. makefiles_include_mk.ex
  14. requirements.txt
  15. transition.mk
README.md

onf-make library makefiles

This repository contains common makefile logic and targets that can be used to build arbitrary repositories. Makefile logic is currently being consumed by the VOLTHA project

makefiles/ subdirectories

Two distinct sets of makefiles are needed to support builds:

  • The first is a subdir of makefiles/ named 'onf-make'

    • This directory exists and is maintained as a git-submodule of repo:onf-make.
    • Library makefiles contain independent logic to install common tools such as (virtualenv), perform linting tasks, define constants and perform path/string manipulation, etc.
  • The second makefile directory contains repository/project specific logic:

    • makefiles/local/ exists as a repository subdirectory under SCM.
    • Contains custom targets, variant parameters and custom logic specific to the repository it exists within.
  • Most makefile logic can be parameterized and implemented to support reuse. Consider adding enhancements or refactoring local/ makefile logic into repo:onf-make so all makefiles can leverage it.

Hierarchy

% tree --charset=ascii -n

Makefile
config.mk
makefiles/
|-- include.mk
|-- local
|   |-- include.mk
|   |   |   |-- doc8
|   |   |   |    |-- doc8.ini   (alas only one --config switch allowed)
|-- [onf-make: git-submodule](https://github.com/opencord/onf-make)
|   |-- makefiles
|   |   |-- consts.mk
|   |   |-- include.mk
|   |   |-- lint
|   |   |   |-- doc8            Syntax check ReStructuredText (rst) files
|   |   |   |-- groovy
|   |   |   |-- python
|   |   |   |-- robot.mk        Syntax check robot testing framework
|   |   |   |-- shell.mk        Invoke shellcheck command on scripts
|   |   |   |-- yaml            Syntax check yaml configs

NOTES

  • Ascii art was rendered using

    • tree --charset=ascii -n
  • README.md can be rendered locally using

    • pandoc README.md | lynx -stdin
    • make view

SEE ALSO

-----------------------------------------------------------------------

Copyright 2023-2024 Open Networking Foundation Contributors

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.

-----------------------------------------------------------------------

SPDX-FileCopyrightText: 2023-2024 Open Networking Foundation Contributors

SPDX-License-Identifier: Apache-2.0

-----------------------------------------------------------------------

Intent:

-----------------------------------------------------------------------