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