Vcpkg cleanup (#767)

* Add vcpkg setup instructions * Update docs * windowsce project removal and add vcpkg message in build failure warning
Azure · Dec 13, 2018 · 65cfd7a · 65cfd7a
1 parent f27b081
commit 65cfd7a
Show file tree

Hide file tree

Showing 20 changed files with 160 additions and 374 deletions.
diff --git a/doc/setting_up_vcpkg.md b/doc/setting_up_vcpkg.md
@@ -0,0 +1,94 @@
+# Building applications using vcpkg for C SDK
+
+This document describes how to setup vcpkg to build applications using Microsoft Azure IoT device SDK for C. It demonstrates building sample projects in Windows using the Visual Studio project files included in the SDK. It also demonstrates building standalone applications using cmake project files in Linux and Mac.
+
+## Setup C SDK vcpkg for Windows development environment
+
+- Open a command prompt and run the following commands:
+
+```Shell
+
+# Clone vcpkg
+git clone https://github.com/Microsoft/vcpkg.git vcpkg_new
+
+# Bootstrap and install Visual Studio integration
+pushd vcpkg_new
+.\bootstrap-vcpkg.bat
+vcpkg integrate install
+
+# Install azure-iot-sdk-c package
+vcpkg install azure-iot-sdk-c
+
+# Export nuget package locally
+vcpkg export azure-iot-sdk-c --nuget
+
+# Open a C SDK sample (assuming repo was cloned as follows: git clone https://github.com/Azure/azure-iot-sdk-c.git azureiotsdk_sample)
+pushd azureiotsdk_sample\iothub_client\samples\iothub_ll_c2d_sample\windows
+start iothub_ll_c2d_sample.sln
+<hit F5 to build and run>
+```
+
+- Alternatively, if the Visual Studio integration step isn't setup, it is possible to build the sample using the locally generated NugGet package. In order to use the locally vcpkg-exported package in Visual Studio, open Nuget package manager console and run the following commands:
+```Shell
+Install-Package <package name provided by vcpkg export command> -Source "d:\d\vcpkg_new"
+<hit F5 to build and run>
+```
+
+## Setup C SDK vcpkg for Linux or Mac development environment	
+		
+- Within an existing C SDK sample cmake file (e.g. iothub_client/samples/iothub_ll_telemetry_sample/linux/CMakeLists.txt), replace the current contents with the following:
+
+```Shell
+#Copyright (c) Microsoft. All rights reserved.	
+#Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+#this is CMakeLists.txt for iothub_ll_telemetry_sample
+cmake_minimum_required(VERSION 2.8.11)
+
+if(WIN32)
+message(FATAL_ERROR "This CMake file is only support Linux builds!")
+endif()
+
+set(AZUREIOT_INC_FOLDER ".." "/usr/include/azureiot" "/usr/include/azureiot/inc")
+find_package(azure_iot_sdks REQUIRED)
+find_package(ZLIB REQUIRED)
+
+include_directories(${AZUREIOT_INC_FOLDER})
+
+set(iothub_c_files
+../iothub_ll_telemetry_sample.c
+../../../../certs/certs.c
+)
+
+add_definitions(-DUSE_HTTP)
+add_definitions(-DUSE_AMQP)
+add_definitions(-DUSE_MQTT)
+
+add_definitions(-DSET_TRUSTED_CERT_IN_SAMPLES)
+include_directories("../../../../certs")
+
+add_executable(iothub_ll_telemetry_sample ${iothub_c_files})
+find_library(CURL NAMES curl-d curl)
+target_link_libraries(iothub_ll_telemetry_sample
+iothub_client_mqtt_transport
+iothub_client_amqp_transport
+iothub_client
+parson
+aziotsharedutil
+umqtt
+uuid
+${CURL}
+pthread
+ssl
+crypto
+m
+ZLIB::ZLIB
+)
+```
+
+- Run following commands in the newly created cmake directory:
+```Shell
+cmake .. -DCMAKE_TOOLCHAIN_FILE=~/vcpkg_new/scripts/buildsystems/vcpkg.cmake
+cmake --build .
+./iothub_ll_telemetry_sample
+```
diff --git a/...s/iothub_client_sample_upload_to_blob/windows/iothub_client_sample_upload_to_blob.vcxproj b/...s/iothub_client_sample_upload_to_blob/windows/iothub_client_sample_upload_to_blob.vcxproj
@@ -163,4 +163,10 @@
     <ClCompile Include="..\iothub_client_sample_upload_to_blob.c" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/...lient/samples/iothub_client_sample_upload_to_blob/windowsce/iothub_client_sample_http.sln b/...lient/samples/iothub_client_sample_upload_to_blob/windowsce/iothub_client_sample_http.sln
diff --git a/...t/samples/iothub_client_sample_upload_to_blob/windowsce/iothub_client_sample_http.vcxproj b/...t/samples/iothub_client_sample_upload_to_blob/windowsce/iothub_client_sample_http.vcxproj
diff --git a/iothub_client/samples/iothub_client_sample_upload_to_blob/windowsce/main.c b/iothub_client/samples/iothub_client_sample_upload_to_blob/windowsce/main.c
diff --git a/...ub_client_sample_upload_to_blob_mb/windows/iothub_client_sample_upload_to_blob_mb.vcxproj b/...ub_client_sample_upload_to_blob_mb/windows/iothub_client_sample_upload_to_blob_mb.vcxproj
@@ -161,4 +161,10 @@
     <ClCompile Include="..\iothub_client_sample_upload_to_blob_mb.c" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/iothub_client/samples/iothub_ll_c2d_sample/windows/iothub_ll_c2d_sample.vcxproj b/iothub_client/samples/iothub_ll_c2d_sample/windows/iothub_ll_c2d_sample.vcxproj
@@ -183,4 +183,10 @@
     <ClInclude Include="..\..\..\..\certs\certs.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/...s/iothub_ll_client_sample_amqp_shared/windows/iothub_ll_client_sample_amqp_shared.vcxproj b/...s/iothub_ll_client_sample_amqp_shared/windows/iothub_ll_client_sample_amqp_shared.vcxproj
@@ -160,4 +160,10 @@
     <ClInclude Include="..\iothub_ll_client_sample_amqp_shared.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/iothub_client/samples/iothub_ll_telemetry_sample/windows/iothub_ll_telemetry_sample.vcxproj b/iothub_client/samples/iothub_ll_telemetry_sample/windows/iothub_ll_telemetry_sample.vcxproj
@@ -183,4 +183,10 @@
     <ClInclude Include="..\..\..\..\certs\certs.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/serializer/samples/devicemethod_simplesample/windows/devicemethod_simplesample.vcxproj b/serializer/samples/devicemethod_simplesample/windows/devicemethod_simplesample.vcxproj
@@ -163,4 +163,10 @@
     <ClInclude Include="..\devicemethod_simplesample.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/serializer/samples/remote_monitoring/windows/remote_monitoring.vcxproj b/serializer/samples/remote_monitoring/windows/remote_monitoring.vcxproj
@@ -162,4 +162,10 @@
     <ClInclude Include="..\remote_monitoring.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('$(VcpkgRoot)include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)include\azureiot\iothub.h'))" />
+  </Target>
 </Project>
diff --git a/serializer/samples/remote_monitoring/windowsce/remote_monitoring.sln b/serializer/samples/remote_monitoring/windowsce/remote_monitoring.sln