Feature/support x86 md python build scripts (#172)

* removed whitespaces

* support for msvc runtime and x86

* copy custom triplets before using vcpkg

* adding set of predefined vcpkg configs

* catch vcpkg errors

* passing required argument to function

* cleanup packages directory after vcpkg build

* adding /md,/mt and x86 to desktop workflow

* temporarily switching on workflow for push event.

* install python on x64 only and vcpkg cache key updated

Python 3.7 does not exist on linux x86. Use x64 for Python regardless
of architecture.

* install x86 linux libs before building for x86

* fixed function name

* removing call to apt python module

* reorganized vcpkg files for customized data

* pointing to newly organized vcpkg custom data

copying over custom triplets and toolchains to vcpkg
fixed paths to response files

* fixed path to relocated response files

* using shutil.copy instead of shutil.copyfile

* fixed copy of custom vcpkg data

* install support infrastructure for x86 linux

install all required x86 libs for cross compiling on x64 hosts
use a separate cmake toolchain for linux x86

* disable unit tests for x86

* fix toolchain file name

* respecting config flag in cmake build

Some multi-config generators specify the config (Release vs Debug)
during cmake build and not cmake configure.

* reverting temp change to run workflow on push

* script to inspect built libraries

* added windows support

* more changes for finding arch from windows libs

* inspect msvc_runtime_linkage

* added cmd line flags

* refactored code to support verbose and summarized output

* support for * in library filter cmd line flag

* pretty print summary table

* add msvc runtime to headers

* added an option to cleanup temp data

* alphabetic import of modules

* added google copyright and module docstring

* added windows example to docstring

* removed cleanup flag and added docstrings.

* fixed some docstrings

* adding new python inspection script and temporarily switching on push trigger

* fixed typo

* lru_cache with default arggs

* debug linux lib instrospection

* accounting for arch output like i386:x86-64 in regex for linux

* continue workflow even if python step fails

* forcing /MD and /MT

* temporary switch on push trigger

* removing special handling for linux x86

* fixed syntax errors

* modifying external dependencies after cmake configure

* not using temp dir for a quick test

* fixed download function

* removing push trigger

* remove deprecated cmd line flag

* keeping the name consistent across repo scripts

* removed cmake /MT override for GoogleTest

* removed custom vcpkg configs as they have been moved to vcpkg_custom_data

* addressed PR comments

Quotes around strings for consistency
Inspect instead of introspect

* added copyright

* added copyright

* quotes around literal string

Author: vimanyu

.github/workflows/desktop.yml

@@ -1,6 +1,6 @@
 name: Desktop Builds
 
-on: 
+on:
   pull_request:
     types: [opened, reopened, synchronize]
 
@@ -9,26 +9,34 @@ env:
 
 jobs:
   build:
-    name: ${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.python_version }}
+    name: ${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.msvc_runtime}}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
         build_type: ["Release", "Debug"]
-        architecture: ["x64",]
+        architecture: ["x64", "x86"]
+        msvc_runtime: ["static", "dynamic"]
         python_version: [3.7]
         include:
         - os: windows-latest
-          architecture: "x64"
-          vcpkg_triplet: "x64-windows-static"
-          msbuild_platform: "x64"
+          vcpkg_triplet_suffix: "windows-static"
+        - os: windows-latest
+          msvc_runtime: "dynamic"
+          vcpkg_triplet_suffix: "windows-static-md"
         - os: ubuntu-latest
-          architecture: "x64"
-          vcpkg_triplet: "x64-linux"
+          vcpkg_triplet_suffix: "linux"
+        - os: macos-latest
+          vcpkg_triplet_suffix: "osx"
+
+        exclude:
         - os: macos-latest
-          architecture: "x64"
-          vcpkg_triplet: "x64-osx"
+          architecture: "x86"
+        - os: macos-latest
+          msvc_runtime: "dynamic"
+        - os: ubuntu-latest
+          msvc_runtime: "dynamic"
 
     steps:
       - uses: actions/checkout@v2
@@ -37,15 +45,15 @@ jobs:
 
       - name: Set env variables for subsequent steps (all)
         run: |
-          echo "::set-env name=VCPKG_RESPONSE_FILE::external/vcpkg_${{ matrix.vcpkg_triplet }}_response_file.txt"
-          echo "::set-env name=MATRIX_UNIQUE_NAME::${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.python_version }}"
+          echo "::set-env name=VCPKG_RESPONSE_FILE::external/vcpkg_custom_data/response_files/${{ matrix.architecture }}-${{ matrix.vcpkg_triplet_suffix }}.txt"
+          echo "::set-env name=MATRIX_UNIQUE_NAME::${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.architecture }}-${{ matrix.msvc_runtime }}"
 
       - name: Cache vcpkg C++ dependencies
         id: cache_vcpkg
         uses: actions/cache@v2
         with:
           path: external/vcpkg/installed
-          key: dev-vcpkg-${{ matrix.vcpkg_triplet }}-${{ hashFiles(format('{0}', env.VCPKG_RESPONSE_FILE)) }}-${{ hashFiles('.git/modules/external/vcpkg/HEAD') }}
+          key: dev-vcpkg-${{ matrix.architecture }}-${{ matrix.vcpkg_triplet_suffix }}-${{ matrix.msvc_runtime }}-${{ hashFiles(format('{0}', env.VCPKG_RESPONSE_FILE)) }}-${{ hashFiles('.git/modules/external/vcpkg/HEAD') }}
 
       - name: Cache ccache files
         if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macos')
@@ -59,15 +67,15 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python_version }}
-          architecture: ${{ matrix.architecture }}
+          architecture: 'x64'
 
       - name: Install prerequisites
         run: |
           python scripts/gha/install_prereqs_desktop.py
 
       - name: Build SDK
         run: |
-          python scripts/gha/build_desktop.py --build_tests --arch "${{ matrix.architecture }}" --config "${{ matrix.build_type }}"
+          python scripts/gha/build_desktop.py --build_tests --arch "${{ matrix.architecture }}" --config "${{ matrix.build_type }}" --msvc_runtime_library "${{ matrix.msvc_runtime }}"
 
       - name: Stats for ccache (mac and linux)
         if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macos')
@@ -82,23 +90,30 @@ jobs:
           find build -name "*.a"
           find build -name "*.so"
 
+      - name: Inspect firebase libraries for cpu arch and msvc runtime.
+        shell: bash
+        run: |
+          python scripts/gha/inspect_built_libraries.py build/
+        continue-on-error: true
+
       - name: Prep crash support (linux)
-        # Ensures directory structure is in place to capture core files on Linux. 
+        # Ensures directory structure is in place to capture core files on Linux.
         if: startsWith(matrix.build_type, 'Debug') && startsWith(matrix.os, 'ubuntu')
         shell: bash
         run: |
           echo '/tmp/cores/core.%E' | sudo tee /proc/sys/kernel/core_pattern
           sudo mkdir -p /tmp/cores/
           sudo rm -rf /tmp/cores/*
-          
+
       - name: Prep crash support (mac)
         # Ensures no lingering crashes from the previous run.
         if: startsWith(matrix.build_type, 'Debug') && startsWith(matrix.os, 'macos')
         run: |
           rm -rf ~/Library/Logs/DiagnosticReports/*
-          
+
       - name: Run unit tests (windows & macos)
-        if: startsWith(matrix.os, 'windows') || startsWith(matrix.os, 'macos')
+        # TODO: Enable tests for x86 once they are all working
+        if: (startsWith(matrix.os, 'windows') || startsWith(matrix.os, 'macos')) && matrix.architecture != 'x86'
         env:
           LANG: en_US
         run: |
@@ -110,14 +125,15 @@ jobs:
         # platform-specific `ulimit` to enable crash collection.  The ulimit
         # command must be invoked in same shell instance of that runs the
         # tests.
-        if: startsWith(matrix.os, 'ubuntu')
+        # TODO: Enable tests for x86 once they are all working
+        if: startsWith(matrix.os, 'ubuntu') && matrix.architecture != 'x86'
         env:
           LANG: en_US
         run: |
-          ulimit -c unlimited 
+          ulimit -c unlimited
           cd build
           sudo ctest --verbose
-      
+
       - name: Prep bins for achive (linux)
         # Copies all of the binary files into one directory for ease in
         # archiving. Directory contents are then marked readable for the
@@ -147,7 +163,7 @@ jobs:
         shell: bash
         if: failure() && startsWith(matrix.build_type, 'Debug') && startsWith(matrix.os, 'macos')
         run: |
-          sudo chmod -R +rwx ~/Library/Logs/DiagnosticReports/* || :           
+          sudo chmod -R +rwx ~/Library/Logs/DiagnosticReports/* || :
 
       - name: Archive crashes and binaries (linux)
         uses: actions/upload-artifact@v2
@@ -166,4 +182,3 @@ jobs:
           path: |
             ~/Library/Logs/DiagnosticReports/*
             /tmp/bins/*
-

CMakeLists.txt

@@ -121,23 +121,20 @@ set(FIREBASE_GEN_FILE_DIR ${CMAKE_BINARY_DIR}/generated)
 # Directory for any shared scripts.
 set(FIREBASE_SCRIPT_DIR ${CMAKE_CURRENT_LIST_DIR})
 
-if (MSVC AND MSVC_RUNTIME_LIBRARY_STATIC)
-  # Use Multithreaded static runtime libraries for MSVC 
-  # if MSVC_RUNTIME_LIBRARY_STATIC is set.
-  # Default value if nothing is specified is /MD (dll dynamic runtime).
-  set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /MTd")
-  set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /MT")
-  set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd")
-  set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT")
-endif()
-  
-if (FIREBASE_CPP_BUILD_TESTS AND MSVC)
-  # GoogleTest requires MSVC to compile with the static version of the runtime
-  # library, so define the appropriate runtime flag, before adding libraries.
-  set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /MTd")
-  set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /MT")
-  set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd")
-  set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT")
+if (MSVC)
+  if (MSVC_RUNTIME_LIBRARY_STATIC)
+    add_compile_options(
+      $<$<CONFIG:>:/MT>
+      $<$<CONFIG:Debug>:/MTd>
+      $<$<CONFIG:Release>:/MT>
+  )
+  else()
+    add_compile_options(
+      $<$<CONFIG:>:/MD>
+      $<$<CONFIG:Debug>:/MDd>
+      $<$<CONFIG:Release>:/MD>
+  )
+  endif()
 endif()
 
 # Set variables that are used by download_external_sources.

build_scripts/desktop/get_variant.sh

@@ -29,7 +29,7 @@ os=
 arch=
 arch_win=
 debugmode=Release
-msvc_crt_linkage=MD
+msvc_runtime_library=MD
 vs=VS2015
 stl=c++
 
@@ -99,16 +99,16 @@ for c in $(echo "${filename}" | tr "_.-" "\n\n\n"); do
 	;;
 	# Windows OS framework linkages
 	md)
-	    msvc_crt_linkage=MD
+	    msvc_runtime_library=MD
 	;;
 	dynamic)
-	    msvc_crt_linkage=MD
+	    msvc_runtime_library=MD
 	;;
 	mt)
-	    msvc_crt_linkage=MT
+	    msvc_runtime_library=MT
 	;;
 	static)
-	    msvc_crt_linkage=MT
+	    msvc_runtime_library=MT
 	    ;;
 	# Debug/Release compilation mode
 	release)
@@ -161,7 +161,7 @@ case ${os} in
 	    echo "Invalid architecture for Windows: ${arch}" 1>&2
 	    exit 1
 	fi
-	echo -n "${vs}/${msvc_crt_linkage}/${arch_win}/${debugmode}"
+	echo -n "${vs}/${msvc_runtime_library}/${arch_win}/${debugmode}"
     ;;
     ios)
 	if [[ -z "${arch}" ]]; then

cmake/toolchains/linux_32.cmake

@@ -1,3 +1,17 @@
+# Copyright 2020 Google
+#
+# 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.
+
 # Toolchain file for building 32-bit Linux libraries
 
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32")

external/vcpkg_x64-linux_response_file.txt renamed to external/vcpkg_custom_data/response_files/x64-linux.txt

@@ -2,4 +2,4 @@ openssl
 protobuf
 zlib
 --triplet
-x64-windows
+x64-windows-static-md

external/vcpkg_x64-osx_response_file.txt renamed to external/vcpkg_custom_data/response_files/x64-osx.txt

@@ -2,4 +2,4 @@ openssl
 protobuf
 zlib
 --triplet
-x86-windows
+x86-windows-static-md