github.com/blockchain-gm/fabric-ca@v0.0.0-20200423072702-b2c40c7ac69c/Makefile (about)

     1  # Copyright IBM Corp All Rights Reserved.
     2  # Copyright London Stock Exchange Group All Rights Reserved.
     3  #
     4  # SPDX-License-Identifier: Apache-2.0
     5  #
     6  # -------------------------------------------------------------
     7  # This makefile defines the following targets
     8  #
     9  #   - all (default) - builds all targets and runs all tests
    10  #   - license - check all go files for license headers
    11  #   - fabric-ca-server - builds the fabric-ca-server executable
    12  #   - fabric-ca-client - builds the fabric-ca-client executable
    13  #   - unit-tests - runs the go-test based unit tests
    14  #   - checks - runs all check conditions (license, format, imports, lint and vet)
    15  #   - docker[-clean] - ensures all docker images are available[/cleaned]
    16  #   - docker-fabric-ca - build the fabric-ca docker image
    17  #   - bench - Runs benchmarks in all the packages and stores the results in /tmp/bench.results
    18  #   - bench-cpu - Runs the benchmarks in the specified package with cpu profiling
    19  #   - bench-mem - Runs the benchmarks in the specified package with memory profiling
    20  #   - bench-clean - Removes all benchmark related files
    21  #   - benchcmp - Compares benchmarks results of current and previous release
    22  #   - release - builds fabric-ca-client binary for the host platform. Binary built with this target will not support pkcs11
    23  #   - release-all - builds fabric-ca-client binary for all target platforms. Binaries built with this target will not support pkcs11
    24  #   - dist - builds release package for the host platform
    25  #   - dist-all - builds release packages for all target platforms
    26  #   - clean - cleans the build area
    27  #   - release-clean - cleans the binaries for all target platforms
    28  #   - dist-clean - cleans release packages for all target platforms
    29  #   - clean-all - cleans the build area and release packages
    30  export GO111MODULE=off
    31  
    32  PROJECT_NAME = fabric-ca
    33  BASE_VERSION = 1.4.3
    34  PREV_VERSION = 1.4.2
    35  IS_RELEASE = true
    36  
    37  ARCH=$(shell go env GOARCH)
    38  MARCH=$(shell go env GOOS)-$(shell go env GOARCH)
    39  STABLE_TAG ?= $(ARCH)-$(BASE_VERSION)-stable
    40  
    41  ifneq ($(IS_RELEASE),true)
    42  EXTRA_VERSION ?= snapshot-$(shell git rev-parse --short HEAD)
    43  PROJECT_VERSION=$(BASE_VERSION)-$(EXTRA_VERSION)
    44  FABRIC_TAG ?= latest
    45  else
    46  PROJECT_VERSION=$(BASE_VERSION)
    47  FABRIC_TAG ?= $(ARCH)-$(BASE_VERSION)
    48  endif
    49  
    50  ifeq ($(ARCH),s390x)
    51  PGVER=9.6
    52  else
    53  PGVER=9.5
    54  endif
    55  
    56  BASEIMAGE_RELEASE = 0.4.15
    57  PKGNAME = github.com/hyperledger/$(PROJECT_NAME)
    58  
    59  METADATA_VAR = Version=$(PROJECT_VERSION)
    60  
    61  GO_SOURCE := $(shell find . -name '*.go')
    62  GO_LDFLAGS = $(patsubst %,-X $(PKGNAME)/lib/metadata.%,$(METADATA_VAR))
    63  export GO_LDFLAGS
    64  
    65  IMAGES = $(PROJECT_NAME)
    66  FVTIMAGE = $(PROJECT_NAME)-fvt
    67  
    68  RELEASE_PLATFORMS = linux-amd64 darwin-amd64 linux-ppc64le linux-s390x windows-amd64
    69  RELEASE_PKGS = fabric-ca-client
    70  
    71  path-map.fabric-ca-client := cmd/fabric-ca-client
    72  path-map.fabric-ca-server := cmd/fabric-ca-server
    73  
    74  include docker-env.mk
    75  
    76  all: rename docker unit-tests
    77  
    78  rename: .FORCE
    79  	@scripts/rename-repo
    80  
    81  docker: $(patsubst %,build/image/%/$(DUMMY), $(IMAGES))
    82  
    83  docker-all: docker
    84  
    85  docker-fabric-ca: docker
    86  
    87  docker-fvt: $(patsubst %,build/image/%/$(DUMMY), $(FVTIMAGE))
    88  
    89  changelog:
    90  	./scripts/changelog.sh v$(PREV_VERSION) HEAD v$(BASE_VERSION)
    91  
    92  checks: license vet lint format imports
    93  
    94  license: .FORCE
    95  	@scripts/check_license
    96  
    97  format: .FORCE
    98  	@scripts/check_format
    99  
   100  imports: .FORCE
   101  	@scripts/check_imports
   102  
   103  lint: .FORCE
   104  	@scripts/check_lint
   105  
   106  vet: .FORCE
   107  	@scripts/check_vet
   108  
   109  docs: fabric-ca-client fabric-ca-server
   110  	@scripts/regenDocs
   111  
   112  fabric-ca-client: bin/fabric-ca-client
   113  fabric-ca-server: bin/fabric-ca-server
   114  
   115  bin/%: $(GO_SOURCE)
   116  	@echo "Building ${@F} in bin directory ..."
   117  	@mkdir -p bin && go build -o bin/${@F} -tags "pkcs11" -ldflags "$(GO_LDFLAGS)" $(PKGNAME)/$(path-map.${@F})
   118  	@echo "Built bin/${@F}"
   119  
   120  # We (re)build a package within a docker context but persist the $GOPATH/pkg
   121  # directory so that subsequent builds are faster
   122  build/docker/bin/%:
   123  	@echo "Building $@"
   124  	@mkdir -p $(@D) build/docker/$(@F)/pkg
   125  	@$(DRUN) \
   126  		-v $(abspath build/docker/bin):/opt/gopath/bin \
   127  		-v $(abspath build/docker/$(@F)/pkg):/opt/gopath/pkg \
   128  		$(BASE_DOCKER_NS)/fabric-baseimage:$(BASE_DOCKER_TAG) \
   129  		go install -ldflags "$(DOCKER_GO_LDFLAGS)" $(PKGNAME)/$(path-map.${@F})
   130  	@touch $@
   131  
   132  build/image/%/$(DUMMY): Makefile build/image/%/payload
   133  	$(eval TARGET = ${patsubst build/image/%/$(DUMMY),%,${@}})
   134  	$(eval DOCKER_NAME = $(DOCKER_NS)/$(TARGET))
   135  	@echo "Building docker $(TARGET) image"
   136  	@cat images/$(TARGET)/Dockerfile.in \
   137  		| sed -e 's|_BASE_NS_|$(BASE_DOCKER_NS)|g' \
   138  		| sed -e 's|_NS_|$(DOCKER_NS)|g' \
   139  		| sed -e 's|_NEXUS_REPO_|$(NEXUS_URL)|g' \
   140  		| sed -e 's|_BASE_TAG_|$(BASE_DOCKER_TAG)|g' \
   141  		| sed -e 's|_FABRIC_TAG_|$(FABRIC_TAG)|g' \
   142  		| sed -e 's|_STABLE_TAG_|$(STABLE_TAG)|g' \
   143  		| sed -e 's|_TAG_|$(DOCKER_TAG)|g' \
   144  		| sed -e 's|_PGVER_|$(PGVER)|g' \
   145  		> $(@D)/Dockerfile
   146  	$(DBUILD) -t $(DOCKER_NAME) --build-arg FABRIC_CA_DYNAMIC_LINK=$(FABRIC_CA_DYNAMIC_LINK) $(@D)
   147  	docker tag $(DOCKER_NAME) $(DOCKER_NAME):$(DOCKER_TAG)
   148  	@touch $@
   149  
   150  build/image/fabric-ca/payload: \
   151  	build/docker/bin/fabric-ca-client \
   152  	build/docker/bin/fabric-ca-server \
   153  	build/fabric-ca.tar.bz2
   154  build/image/fabric-ca-fvt/payload: \
   155  	build/docker/bin/fabric-ca-client \
   156  	build/docker/bin/fabric-ca-server \
   157  	build/fabric-ca-fvt.tar.bz2
   158  build/image/%/payload:
   159  	@echo "Copying $^ to $@"
   160  	mkdir -p $@
   161  	cp $^ $@
   162  
   163  build/fabric-ca.tar.bz2: $(shell git ls-files images/fabric-ca/payload)
   164  
   165  build/fabric-ca-fvt.tar.bz2: $(shell find images/fabric-ca-fvt/payload/ -maxdepth 1)
   166  
   167  build/%.tar.bz2:
   168  	@echo "Building $@"
   169  	@tar -jc -C images/$*/payload $(notdir $^) > $@
   170  
   171  all-tests: checks fabric-ca-server fabric-ca-client
   172  	@scripts/run_unit_tests
   173  	@scripts/run_integration_tests
   174  
   175  unit-tests: fabric-ca-server fabric-ca-client
   176  	@scripts/run_unit_tests
   177  
   178  unit-test: unit-tests
   179  
   180  int-tests: checks fabric-ca-server fabric-ca-client
   181  	@scripts/run_integration_tests
   182  
   183  # Runs benchmarks in all the packages and stores the benchmarks in /tmp/bench.results
   184  bench: checks fabric-ca-server fabric-ca-client
   185  	@scripts/run_benchmarks
   186  
   187  # Runs benchmarks in the specified package with cpu profiling
   188  # e.g. make bench-cpu pkg=github.com/hyperledger/fabric-ca/lib
   189  bench-cpu: checks fabric-ca-server fabric-ca-client
   190  	@scripts/run_benchmarks -C -P $(pkg)
   191  
   192  # Runs benchmarks in the specified package with memory profiling
   193  # e.g. make bench-mem pkg=github.com/hyperledger/fabric-ca/lib
   194  bench-mem: checks fabric-ca-server fabric-ca-client
   195  	@scripts/run_benchmarks -M -P $(pkg)
   196  
   197  # e.g. make benchcmp prev_rel=v1.0.0
   198  benchcmp: guard-prev_rel bench
   199  	@scripts/compare_benchmarks $(prev_rel)
   200  
   201  guard-%:
   202  	@if [ "${${*}}" = "" ]; then \
   203  		echo "Environment variable $* not set"; \
   204  		exit 1; \
   205  	fi
   206  
   207  
   208  # Removes all benchmark related files (bench, bench-cpu, bench-mem and *.test)
   209  bench-clean:
   210  	@scripts/run_benchmarks -R
   211  
   212  container-tests: docker
   213  
   214  load-test: docker-clean docker-fvt
   215  	@docker run -p 8888:8888 -p 8054:8054 -v $(shell pwd):/opt/gopath/src/github.com/hyperledger/fabric-ca -e FABRIC_CA_SERVER_PROFILE_PORT=8054 --name loadTest -td hyperledger/fabric-ca-fvt test/fabric-ca-load-tester/launchServer.sh 3
   216  	@test/fabric-ca-load-tester/runLoad.sh -B
   217  	@docker kill loadTest
   218  
   219  fvt-tests:
   220  	@scripts/run_fvt_tests
   221  
   222  ci-tests: docker-clean all-tests docker-fvt docs
   223  	@docker run -v $(shell pwd):/opt/gopath/src/github.com/hyperledger/fabric-ca ${DOCKER_NS}/fabric-ca-fvt
   224  
   225  %-docker-clean:
   226  	$(eval TARGET = ${patsubst %-docker-clean,%,${@}})
   227  	-docker images -q $(DOCKER_NS)/$(TARGET):latest | xargs -I '{}' docker rmi -f '{}'
   228  	-docker images -q $(NEXUS_URL)/*:$(STABLE_TAG) | xargs -I '{}' docker rmi -f '{}'
   229  	-@rm -rf build/image/$(TARGET) ||:
   230  
   231  docker-clean: $(patsubst %,%-docker-clean, $(IMAGES) $(PROJECT_NAME)-fvt)
   232  	@rm -rf build/docker/bin/* ||:
   233  
   234  native: fabric-ca-client fabric-ca-server
   235  
   236  release: $(patsubst %,release/%, $(MARCH))
   237  release-all: $(patsubst %,release/%, $(RELEASE_PLATFORMS))
   238  
   239  release/windows-amd64: GOOS=windows
   240  release/windows-amd64: CC=/usr/bin/x86_64-w64-mingw32-gcc
   241  release/windows-amd64: GO_TAGS+= caclient
   242  release/windows-amd64: $(patsubst %,release/windows-amd64/bin/%, $(RELEASE_PKGS))
   243  
   244  release/darwin-amd64: GOOS=darwin
   245  release/darwin-amd64: CC=/usr/bin/clang
   246  release/darwin-amd64: GO_TAGS+= caclient
   247  release/darwin-amd64: $(patsubst %,release/darwin-amd64/bin/%, $(RELEASE_PKGS))
   248  
   249  release/linux-amd64: GOOS=linux
   250  release/linux-amd64: GO_TAGS+= caclient
   251  release/linux-amd64: $(patsubst %,release/linux-amd64/bin/%, $(RELEASE_PKGS))
   252  
   253  release/%-amd64: GOARCH=amd64
   254  
   255  release/linux-%: GOOS=linux
   256  
   257  release/linux-ppc64le: GOARCH=ppc64le
   258  release/linux-ppc64le: GO_TAGS+= caclient
   259  release/linux-ppc64le: CC=/usr/bin/powerpc64le-linux-gnu-gcc
   260  release/linux-ppc64le: $(patsubst %,release/linux-ppc64le/bin/%, $(RELEASE_PKGS))
   261  
   262  release/linux-s390x: GOARCH=s390x
   263  release/linux-s390x: GO_TAGS+= caclient
   264  release/linux-s390x: $(patsubst %,release/linux-s390x/bin/%, $(RELEASE_PKGS))
   265  
   266  release/%/bin/fabric-ca-client: $(GO_SOURCE)
   267  	@echo "Building $@ for $(GOOS)-$(GOARCH)"
   268  	mkdir -p $(@D)
   269  	GOOS=$(GOOS) GOARCH=$(GOARCH) go build -o $(abspath $@) -tags "$(GO_TAGS)" -ldflags "$(GO_LDFLAGS)" $(PKGNAME)/$(path-map.$(@F))
   270  
   271  .PHONY: dist
   272  dist: dist-clean release
   273  	cd release/$(MARCH) && tar -czvf hyperledger-fabric-ca-$(MARCH).$(PROJECT_VERSION).tar.gz *
   274  dist-all: dist-clean release-all $(patsubst %,dist/%, $(RELEASE_PLATFORMS))
   275  dist/windows-amd64:
   276  	cd release/windows-amd64 && tar -czvf hyperledger-fabric-ca-windows-amd64.$(PROJECT_VERSION).tar.gz *
   277  dist/darwin-amd64:
   278  	cd release/darwin-amd64 && tar -czvf hyperledger-fabric-ca-darwin-amd64.$(PROJECT_VERSION).tar.gz *
   279  dist/linux-amd64:
   280  	cd release/linux-amd64 && tar -czvf hyperledger-fabric-ca-linux-amd64.$(PROJECT_VERSION).tar.gz *
   281  dist/linux-ppc64le:
   282  	cd release/linux-ppc64le && tar -czvf hyperledger-fabric-ca-linux-ppc64le.$(PROJECT_VERSION).tar.gz *
   283  dist/linux-s390x:
   284  	cd release/linux-s390x && tar -czvf hyperledger-fabric-ca-linux-s390x.$(PROJECT_VERSION).tar.gz *
   285  
   286  .PHONY: clean
   287  clean: docker-clean release-clean
   288  	-@rm -rf build bin ||:
   289  
   290  .PHONY: clean-all
   291  clean-all: clean dist-clean
   292  
   293  %-release-clean:
   294  	$(eval TARGET = ${patsubst %-release-clean,%,${@}})
   295  	-@rm -rf release/$(TARGET)
   296  release-clean: $(patsubst %,%-release-clean, $(RELEASE_PLATFORMS))
   297  
   298  .PHONY: dist-clean
   299  dist-clean:
   300  	-@rm -rf release/windows-amd64/hyperledger-fabric-ca-windows-amd64.$(PROJECT_VERSION).tar.gz ||:
   301  	-@rm -rf release/darwin-amd64/hyperledger-fabric-ca-darwin-amd64.$(PROJECT_VERSION).tar.gz ||:
   302  	-@rm -rf release/linux-amd64/hyperledger-fabric-ca-linux-amd64.$(PROJECT_VERSION).tar.gz ||:
   303  	-@rm -rf release/linux-ppc64le/hyperledger-fabric-ca-linux-ppc64le.$(PROJECT_VERSION).tar.gz ||:
   304  	-@rm -rf release/linux-s390x/hyperledger-fabric-ca-linux-s390x.$(PROJECT_VERSION).tar.gz ||:
   305  
   306  .FORCE:
   307  
   308  generate-metrics-doc:
   309  	@echo "Generating metrics reference documentation..."
   310  	@./scripts/metrics_doc.sh