WCF

https://github.com/dotnet/wcf
Admin
WCF is a .NET Core version of Windows Communication Foundation client libraries for building...
Tokens:39,699
Snippets:297
Trust Score:9.9
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install System.Web.Services.Description package

Source: https://github.com/dotnet/wcf/blob/main/src/System.Web.Services.Description/src/README.md

Use this command to install the System.Web.Services.Description package from NuGet into your project.

```bash
dotnet add package System.Web.Services.Description
```

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

### Start self-hosted WCF test service with StartWCFSelfHostedSvc.cmd

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Run this script on a Windows machine to start a self-hosted WCF test service. It adds firewall rules, generates and installs self-signed test certificates, builds and starts the service in a new CMD window. Requires elevated privileges; type 'exit' in the service window to shut down and clean up.

```batch
StartWCFSelfHostedSvc.cmd
```

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

### Install dotnet-svcutil global tool

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Installs the dotnet-svcutil tool globally from a local package source.

```text
dotnet tool install --global --add-source [RepoRootDir]/artifacts/artifacts/packages/[Release/Debug]/[Shipping/NonShipping]/[dotnet-svcutil.*.nupkg]
```

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

### Install dotnet-svcutil globally

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/src/README-nuget.md

Installs the dotnet-svcutil tool as a global .NET tool. Requires the .NET SDK.

```bash
dotnet tool install --global dotnet-svcutil
```

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

### Run scenario tests with self-hosted service

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/cross-platform-testing.md

Example for a self-hosted WCF service on a machine named MyWindowsMachine.

```bash
./build.sh -outerloop -- /p:ServiceUri=MyWindowsMachine
```

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

### Install Mono CI build and reference assemblies (Fedora/CentOS)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Installs the latest Mono snapshot and PCL reference assemblies on Fedora/CentOS.

```bash
sudo yum install mono-snapshot-latest referenceassemblies-pcl
```

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

### Install Mono CI build and reference assemblies (Debian/Ubuntu)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Installs the latest Mono snapshot and PCL reference assemblies on Debian/Ubuntu.

```bash
sudo apt-get install mono-snapshot-latest referenceassemblies-pcl
```

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

### Install System.ServiceModel.UnixDomainSocket package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.UnixDomainSocket/src/README.md

Use this command to add the System.ServiceModel.UnixDomainSocket NuGet package to your project.

```bash
dotnet add package System.ServiceModel.UnixDomainSocket
```

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

### Install Kerberos Packages on Ubuntu/Debian

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Command to install krb5-config and krb5-user packages for Kerberos setup on Ubuntu/Debian.

```bash
sudo apt-get install krb5-config krb5-user
```

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

### Install System.ServiceModel.Federation package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.Federation/src/README.md

Use this command to add the System.ServiceModel.Federation package to your project from NuGet.

```bash
dotnet add package System.ServiceModel.Federation
```

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

### Set up IIS-hosted WCF test service with SetupWcfIISHostedService.cmd

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Run this script on a Windows machine with IIS to set up an IIS-hosted WCF test service. The {id} is appended to the IIS application name (e.g., 'WCFServiceTest' for 'Test'). The script clones the WCF repository, creates an application pool and application, installs test certificates, and adds an HTTPS binding.

```batch
SetupWcfIISHostedService.cmd {id}
```

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

### Configure krb5.conf realms

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Example configuration for /etc/krb5.conf showing the realm settings with kdc and admin_server entries. Edit these values to match your authentication server.

```text
[realms]
        REALM.DOMAIN.COM = {
                kdc = DC1.REALM.DOMAIN.COM
                admin_server = DC1.REALM.DOMAIN.COM 
        }
```

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

### Run scenario tests with IIS-hosted service

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/cross-platform-testing.md

Example for an IIS-hosted WCF service, using a path like /WcfService1.

```bash
./build.sh -outerloop -- /p:ServiceUri=MyWindowsMachine/WcfService1
```

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

### dotnet publish command for WCF stress tests

Source: https://github.com/dotnet/wcf/blob/main/src/System.Private.ServiceModel/tests/Stress/readme.md

Command to publish the SharedPoolsOfWCFObjects app for deployment to other machines without installing the .NET Core framework. The example targets win7-x64 runtime and outputs to MyPublishedAppFolder.

```bash
dotnet publish -o MyPublishedAppFolder -r win7-x64
```

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

### Install System.ServiceModel.Http package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.Http/src/README.md

Use this command to add the System.ServiceModel.Http NuGet package to your project. It is the standard way to install the package from NuGet.org.

```bash
dotnet add package System.ServiceModel.Http
```

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

### psexec Command to Start Service as LOCAL SYSTEM

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Command to start a command as an elevated LOCAL SYSTEM user, needed when using the self-hosted service. Download psexec from the provided URL.

```text
psexec -s -h <command>
```

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

### Install System.ServiceModel.NetNamedPipe package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.NetNamedPipe/src/README.md

Use this command to add the System.ServiceModel.NetNamedPipe NuGet package to your project.

```bash
dotnet add package System.ServiceModel.NetNamedPipe
```

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

### Install System.ServiceModel.NetTcp package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.NetTcp/src/README.md

Use this dotnet CLI command to add the System.ServiceModel.NetTcp NuGet package to your project.

```bash
dotnet add package System.ServiceModel.NetTcp
```

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

### Install client certificates in Windows containers

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

PowerShell commands to install a client certificate and a certificate authority public key during container build. The client certificate is protected by the password 'password'.

```powershell
$pass = ConvertTo-SecureString -AsPlainText -Force password 
Import-pfxcertificate -certStoreLocation Cert:LocalMachine\My -Password $pass -FilePath client_cert.pfx
Import-Certificate -certStoreLocation Cert:LocalMachine\Root -FilePath cert_authority_public.cer
```

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

### Example: azure-pipelines.yml with 1ES template and multiple outputs

Source: https://github.com/dotnet/wcf/blob/main/eng/common/template-guidance.md

Shows a pipeline extending MicroBuild.1ES.Official.yml, using templates-official/jobs/jobs.yml with templateContext.outputs to publish logs and copy build outputs to the artifact staging directory. Multiple outputs are only applicable when referencing templates-official.

```yaml
# azure-pipelines.yml
extends:
  template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate
  parameters:
    stages:
    - stage: build
      jobs:
      - template: /eng/common/templates-official/jobs/jobs.yml@self
        parameters:
          # 1ES makes use of outputs to reduce security task injection overhead
          templateContext:
            outputs:
            - output: pipelineArtifact
              displayName: 'Publish logs from source'
              continueOnError: true
              condition: always()
              targetPath: $(Build.ArtifactStagingDirectory)/artifacts/log
              artifactName: Logs
          jobs:
          - job: Windows
            steps:
            - script: echo "friendly neighborhood" > artifacts/marvel/spiderman.txt
          # copy build outputs to artifact staging directory for publishing
          - task: CopyFiles@2
              displayName: Gather build output
              inputs:
                SourceFolder: '$(System.DefaultWorkingDirectory)/artifacts/marvel'
                Contents: '**'
                TargetFolder: '$(Build.ArtifactStagingDirectory)/artifacts/marvel'
```

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

### Create and start rolling log with Informational level using logman

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseETW.md

Creates a trace that rolls logging every 10 minutes with Informational level (0x4). The first command creates the trace, and the second starts it. The output file name includes a timestamp.

```bash
logman create trace WCFETWTracing -p  "Microsoft-Windows-Application Server-Applications" 0xFFFFFFFF 0x4 -o C:\temp\WCFETWTrace -f bin -cnf 00:10:00 -v 

mmddhhmm

logman start WCFETWTracing
```

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

### Install System.ServiceModel.Primitives with dotnet add package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.Primitives/src/README.md

Use this command to add the System.ServiceModel.Primitives package to your project. The package is available on NuGet.org.

```bash
dotnet add package System.ServiceModel.Primitives
```

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

### .csproj with nightly WCF package references

Source: https://github.com/dotnet/wcf/blob/main/Documentation/using-prerelease-wcf-packages.md

Example .csproj file changes for VS 2017 RC to reference nightly WCF packages. Includes PackageReference entries for System.ServiceModel packages and Microsoft.NETCore.App.

```xml
  <ItemGroup>
    <PackageReference Include="Microsoft.NETCore.App">
      <Version>1.0.1</Version>
    </PackageReference>
    <PackageReference Include="Microsoft.NET.Sdk">
      <Version>1.0.0-alpha-20161104-2</Version>
      <PrivateAssets>All</PrivateAssets>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Duplex">
      <Version>4.4.0-beta-24707-0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Http">
      <Version>4.4.0-beta-24708-0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.NetTcp">
      <Version>4.4.0-beta-24708-0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Primitives">
      <Version>4.4.0-beta-24708-0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Security">
      <Version>4.4.0-beta-24708-0</Version>
    </PackageReference>
    <PackageReference Include="System.Xml.XmlSerializer">
      <Version>4.3.0-preview1-24530-04</Version>
    </PackageReference>
  </ItemGroup>

```

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

### Start circular logging with Warning level using logman

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseETW.md

Starts a circular log file with Warning level (0x3) for the WCF ETW provider. The command writes to a single file with a maximum size of 500 MB. The output file path is specified on a separate line.

```bash
logman start WCFETWTracing -p "Microsoft-Windows-Application Server-Applications" 0xFFFFFFFF 0x3 -bs 64 -nb 120 320 -ets -ct perf -f bincirc -max 500 -o 

c:\temp\WCFEtwTrace.etl
```

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

### Start circular logging with Informational level using logman

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseETW.md

Starts a circular log file with Informational level (0x4) for the WCF ETW provider. The command writes to a single file with a maximum size of 500 MB. The output file path is specified on a separate line.

```bash
logman start WCFETWTracing -p "Microsoft-Windows-Application Server-Applications" 0xFFFFFFFF  0x4 -bs 64 -nb 120 320 -ets -ct perf -f bincirc -max 500 -o 

c:\temp\WCFEtwTrace.etl
```

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

### Install System.ServiceModel.NetFramingBase package

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.NetFramingBase/src/README.md

Adds the System.ServiceModel.NetFramingBase NuGet package to the project. This package provides common types for NetFraming-based transports such as NetTcp and NetNamedPipe.

```bash
dotnet add package System.ServiceModel.NetFramingBase
```

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

### Start circular logging with Verbose level using logman

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseETW.md

Starts a circular log file with Verbose level (0x5) for the WCF ETW provider. The command writes to a single file with a maximum size of 500 MB. The output file path is specified on a separate line.

```bash
logman start WCFETWTracing -p "Microsoft-Windows-Application Server-Applications" 0xFFFFFFFF  0x5 -bs 64 -nb 120 320 -ets -ct perf -f bincirc -max 500 -o 

c:\temp\WCFEtwTrace.etl
```

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

### project.json with nightly WCF package versions

Source: https://github.com/dotnet/wcf/blob/main/Documentation/using-prerelease-wcf-packages.md

Example project.json file that specifies exact versions for System.ServiceModel packages to test against nightly builds. Note the version numbers like 4.4.0-beta-24708-0 and the import of dnxcore50.

```json
{
  "version": "1.0.0-*",
  "buildOptions": {
    "emitEntryPoint": true
  },
  "dependencies": {
    "Microsoft.NETCore.App": {
      "type": "platform",
      "version": "1.0.0"
    }
  },
  "frameworks": {
    "netcoreapp1.0": {
      "imports": "dnxcore50",
      "dependencies": {
        "System.ServiceModel.Duplex": "4.4.0-beta-24708-0",
        "System.ServiceModel.Http": "4.4.0-beta-24708-0",
        "System.ServiceModel.NetTcp": "4.4.0-beta-24708-0",
        "System.ServiceModel.Security": "4.4.0-beta-24708-0",
        "System.Xml.XmlSerializer": "4.4.0-beta-24708-02"
      }
    }
  }
}

```

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

### Uninstall dotnet-svcutil global tool

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Removes the globally installed dotnet-svcutil tool.

```text
dotnet tool uninstall --global dotnet-svcutil
```

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

### Run scenario tests on Windows

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Runs outerloop scenario tests, automatically starting and stopping self-hosted WCF test services.

```bash
build-tests.cmd -outerloop
```

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

### Run scenario tests as UWP

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Start the local self-hosted test services, run the security-based scenario tests as UWP, and then stop the services. The results are written to bin\tests\Windows_NT.AnyCPU.Debug\Security.TransportSecurity.Tests\netcore50\testresults.xml. On non-Windows environments, use ./Tools/msbuild.sh instead of msbuild.

```bash
src\System.Private.ServiceModel\tools\scripts\StartWCFSelfHostedSvc.cmd

pushd src\System.Private.ServiceModel\tests\Scenarios\Security\TransportSecurity

msbuild /t:BuildAndTest /p:TargetGroup=netstandard1.3 /p:TestTFM=netcore50aot /p:OuterLoop=true /p:TestNugetRuntimeId=win10-x64-aot /p:UseDotNetNativeToolchain=true Security.TransportSecurity.Tests.csproj

popd

src\System.Private.ServiceModel\tools\scripts\StopWCFSelfHostedSvc.cmd
```

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

### NegotiateStream Tests List

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

List of NegotiateStream test names for ambient credentials. Requires self-hosted or IIS-hosted service running under LOCAL SYSTEM context and WCF Test Root CA certificate installed.

```csharp
   StreamingTests.NetTcp_TransportSecurity_StreamedRequest_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_Streamed_RoundTrips_String_WithSingleThreadedSyncContext
   StreamingTests.NetTcp_TransportSecurity_Streamed_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_Streamed_Async_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_StreamedRequest_Async_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_StreamedResponse_Async_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_StreamedResponse_RoundTrips_String
   StreamingTests.NetTcp_TransportSecurity_Streamed_TimeOut_Long_Running_Operation
   StreamingTests.NetTcp_TransportSecurity_Streamed_Async_RoundTrips_String_WithSingleThreadedSyncContext
   Tcp_ClientCredentialTypeTests.SameBinding_DefaultSettings_EchoString
   Tcp_ClientCredentialTypeTests.SameBinding_SecurityModeTransport_EchoString
   NegotiateStream_Http_Tests.NegotiateStream_Http_AmbientCredentials
```

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

### HTTPS Tests List

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

List of HTTPS test names to run manually on Linux. Requires WCF Test Root CA certificate installed on the local machine, which is done automatically by build.sh/build.cmd.

```csharp
   HttpsTests.SameBinding_Soap12_EchoString 
   HttpsTests.CrossBinding_Soap11_EchoString
   HttpsTests.SameBinding_Soap11_EchoString 
   HttpsTests.ServerCertificateValidation_EchoString
   Https_ClientCredentialTypeTests.BasicAuthenticationInvalidPwd_throw_MessageSecurityException
   Https_ClientCredentialTypeTests.BasicAuthentication_RoundTrips_Echo
```

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

### Show SetupWcfIISHostedService.cmd help

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Run this command to display a list of options and sample usage for SetupWcfIISHostedService.cmd.

```batch
SetupWcfIISHostedService.cmd /?
```

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

### Set up IIS-hosted WCF test service with existing repo

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Use this variant of SetupWcfIISHostedService.cmd to point to an existing WCF repository on the IIS machine instead of cloning a new copy. The {id} is appended to the IIS application name.

```batch
SetupWcfIISHostedService.cmd {id} /p:Path-to-WCF-repo
```

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

### Build and run unit tests with ./build.sh

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/cross-platform-testing.md

Run these scripts from the repo root to build the product and run all unit tests. Results are placed in msbuild.log.

```bash
./build.sh
./build.sh -test
```

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

### Build dotnet-svcutil with cibuild.cmd

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Run from the repository root to build the dotnet-svcutil solution in Release configuration with tests disabled and signing disabled.

```text
eng\.common\cibuild.cmd -preparemachine -configuration Release -projects dotnet-svcutil.sln /p:Test=false /p:Sign=false
```

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

### Switch to the Mono snapshot build

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Activates the Mono snapshot environment.

```bash
. mono-snapshot mono
```

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

### Run unit tests on Windows

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Builds the product and runs all unit tests on Windows.

```bash
build.cmd
```

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

### Clone and build WCF

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Clones the WCF repository and runs the build script. Requires Mono prepared beforehand.

```bash
git clone https://github.com/dotnet/wcf.git
cd wcf
./build.sh
```

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

### Build WCF packages on Windows

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Builds all WCF packages and produces NuGet packages under bin\packages. Skips unit tests with /p:SkipTests=true.

```bash
build.cmd -- /p:SkipTests=true
```

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

### Generate WCF Client Project with dotnet new console

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Commands to create a new console project that will be used as the WCF client project. Run in a directory without an existing project file.

```bash
mkdir wcfClient
cd wcfClient
dotnet new console
```

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

### Run unit tests on non-Windows

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Builds the product and runs all unit tests on non-Windows OS.

```bash
./build.sh
```

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

### Build and run the container

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Commands to build the Docker image and run the container, passing the service URL via the --env parameter. The app reads the 'url' environment variable to create the endpoint.

```bash
docker build -t wcf_client_in_container .
docker run --env url=http://server_name/app_name/Service1.svc -it --rm wcf_client_in_container
```

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

### Run dotnet-svcutil with metadata source

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/src/README-nuget.md

Executes the tool with a metadata document path, URL, or endpoint reference (epr). Options are optional.

```bash
dotnet-svcutil <metadataDocumentPath> | <url> | <epr> [options*]
```

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

### Build WCF packages on non-Windows

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Builds all WCF packages on non-Windows OS, skipping unit tests with /p:SkipTests=true.

```bash
./build.sh -- /p:SkipTests=true
```

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

### Run dotnet-svcutil tests with cibuild.cmd

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Executes the test suite for the dotnet-svcutil solution. Test results are written under the artifacts directory.

```text
eng\common\cibuild.cmd -preparemachine -configuration Release -projects dotnet-svcutil.sln /p:Test=True /p:Sign=false
```

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

### Dockerfile for Windows Nano Server

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Dockerfile that uses the microsoft/dotnet-nightly:1.1.1-sdk-nanoserver base image, copies the wcfClient folder, restores packages, builds the project, and runs the client. Uses backslashes in paths for Windows.

```dockerfile
FROM microsoft/dotnet-nightly:1.1.1-sdk-nanoserver
COPY wcfClient wcfClient
RUN dotnet restore wcfClient\wcfClient.csproj
RUN dotnet build wcfClient\wcfClient.csproj
CMD dotnet run -p wcfClient\wcfClient.csproj
```

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

### Run unit tests as UWP with msbuild

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Navigate to the test project folder and use msbuild with the specified parameters to build and run unit tests for System.ServiceModel.Primitives under UWP. The results are written to a testresults.xml file under the bin\tests folder.

```bash
cd src\System.ServiceModel.Primitives\tests

msbuild /t:BuildAndTest /p:TargetGroup=netstandard1.3 /p:TestTFM=netcore50aot /p:TestNugetRuntimeId=win10-x64-aot /p:UseDotNetNativeToolchain=true
```

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

### Dockerfile for Linux

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Dockerfile that uses the microsoft/dotnet-nightly:1.1.1-sdk base image, copies the wcfClient folder, restores packages, builds the project, and runs the client. The CMD uses dotnet run with the project file.

```dockerfile
FROM microsoft/dotnet-nightly:1.1.1-sdk
COPY wcfClient wcfClient
RUN dotnet restore wcfClient/wcfClient.csproj
RUN dotnet build wcfClient/wcfClient.csproj
CMD dotnet run -p wcfClient/wcfClient.csproj
```

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

### List of locally built WCF .nupkg files

Source: https://github.com/dotnet/wcf/blob/main/Documentation/using-prerelease-wcf-packages.md

Shows the .nupkg file names generated by build.cmd in the bin\packages\Debug folder, with version numbers like 4.4.0-beta-24709-0.

```text
System.Private.ServiceModel.4.4.0-beta-24709-0.nupkg
System.ServiceModel.Duplex.4.4.0-beta-24709-0.nupkg
System.ServiceModel.Http.4.4.0-beta-24709-0.nupkg
System.ServiceModel.NetTcp.4.4.0-beta-24709-0.nupkg
System.ServiceModel.Primitives.4.4.0-beta-24709-0.nupkg
System.ServiceModel.Security.4.4.0-beta-24709-0.nupkg
```

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

### Add Mono key and package sources (Fedora/CentOS)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Adds the Mono GPG key and package sources for Fedora/CentOS derivatives, then upgrades the system.

```bash
sudo rpm --import "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"
sudo yum-config-manager --add-repo http://download.mono-project.com/repo/centos/
sudo yum-config-manager --add-repo http://jenkins.mono-project.com/repo/centos/
sudo yum upgrade
```

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

### Sudoers Configuration for build.sh

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Add this line to the sudoers file to allow running InstallRootCertificate.sh without password prompt. Required when running build.sh on Linux.

```text
user ALL=(ALL) NOPASSWD:ALL
```

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

### Command line to specify test conditions

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Use this command to run tests with specific conditions, such as OuterLoop, ServiceUri, Negotiate_Available, and Kerberos_Available. Conditions must be specified on the command line to run conditioned tests.

```bash
build.sh /p:WithCategories=OuterLoop /p:ServiceUri=${ServiceUri} /p:Negotiate_Available=true /p:Kerberos_Available=true
```

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

### Run scenario tests with ./build.sh -outerloop

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/cross-platform-testing.md

Use this script to run scenario tests cross-platform, replacing {URL-to-WCF-service} with the base address of the WCF test service host.

```bash
./build.sh -outerloop -- /p:ServiceUri={URL-to-WCF-service}
```

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

### Run build with coverage

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Run the build script with the -coverage flag to execute all unit and scenario tests and collect code coverage. The results are written to bin\tests\coverage\index.html.

```bash
build.cmd -outerloop -coverage
```

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

### Run stress test with SharedPoolsOfWCFObjects.exe

Source: https://github.com/dotnet/wcf/blob/main/src/System.Private.ServiceModel/tests/Stress/readme.md

Command-line invocation for a stress test. Specify binding, async mode, test name, host name, and duration. The app prints a full parameter list; defaults exist for most parameters.

```text
SharedPoolsOfWCFObjects.exe Binding:NetTcp Async:true Test:HelloWorld HostName:yourserverhostname StressRunDuration:1
```

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

### NuGet.config packageSources section

Source: https://github.com/dotnet/wcf/blob/main/Documentation/using-prerelease-wcf-packages.md

Shows the relevant section of a NuGet.config file that defines multiple package sources, including nuget.org, DotNetMyGet, and a local WcfRepo directory. This configuration is required to use pre-release or locally built WCF packages.

```xml
<packageSources>
  <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
  <add key="nuget.org" value="https://www.nuget.org/api/v2/" />
  <add key="DotNetMyGet" value="https://dotnet.myget.org/f/dotnet-core" />
  <add key="WcfRepo" value="c:\git\wcf\bin\packages\Debug" />
</packageSources>
```

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

### Add Mono key and package sources (Debian/Ubuntu)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Adds the Mono GPG key and package sources for Debian/Ubuntu derivatives, then updates the package list.

```bash
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list
echo "deb http://jenkins.mono-project.com/repo/debian sid main" | sudo tee /etc/apt/sources.list.d/mono-jenkins.list
sudo apt-get update
```

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

### WCF Client Project File (wcfClient.csproj)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Project file created by Visual Studio 2017 that includes references to WCF .NET Core packages. The format may change depending on the SDK version.

```xml
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp1.1</TargetFramework>
  </PropertyGroup>
<ItemGroup>
    <PackageReference Include="System.ServiceModel.Http">
      <Version>4.3.0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.NetTcp">
      <Version>4.3.0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Primitives">
      <Version>4.3.0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Duplex">
      <Version>4.3.0</Version>
    </PackageReference>
    <PackageReference Include="System.ServiceModel.Security">
      <Version>4.3.0</Version>
    </PackageReference>
  </ItemGroup>
</Project>
```

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

### Run scenario tests against IIS-hosted WCF service

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Runs scenario tests against an IIS-hosted WCF service. ServiceUri must be of the form {MachineName}/WCFService{id}. Replace 'myServer' and 'WcfServiceTest' with your machine name and service id. The Windows command uses build-tests.cmd; the non-Windows command uses build-tests.sh.

```shell
build-tests.cmd -outerloop -- /p:ServiceUri=myServer/WcfServiceTest
```

```shell
./build-tests.sh -outerloop -- /p:ServiceUri=myServer/WcfServiceTest
```

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

### Generate client code with settings emulating WCF Connected Service

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Generates client code using options that mimic the default 'WCF Connected Service' behavior in Visual Studio. Includes data binding, namespace mapping, collection type, and a package reference.

```bash
dotnet-svcutil http://example.com/service.svc?wsdl -edb -n "*,MyApplication.ServiceReference1" -ct MyLibrary.MyCollection`1 -r "{{MyLibrary,1.0.0}}"
```

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

### Generate client code from a running service or online metadata documents

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Basic usage to generate client code from a service endpoint URL. The command is `dotnet-svcutil http://example.com/service.svc?wsdl`.

```bash
dotnet-svcutil http://example.com/service.svc?wsdl
```

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

### Run perf test with SharedPoolsOfWCFObjects.exe

Source: https://github.com/dotnet/wcf/blob/main/src/System.Private.ServiceModel/tests/Stress/readme.md

Command-line invocation for a perf test. Specify Program2Run:Perf, maximum throughput tasks, binding, async mode, test name, and host name. Compare sync and async versions as needed.

```text
SharedPoolsOfWCFObjects.exe Program2Run:Perf PerfMaxThroughputTasks:90 Binding:NetTcp Async:true Test:HelloWorld HostName:yourserverhostname
```

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

### Verify Kerberos ticket with klist

Source: https://github.com/dotnet/wcf/blob/main/Documentation/manualtest-guide.md

Run klist to check that the Kerberos ticket was acquired. The output shows the ticket cache, default principal, and ticket validity details.

```text
Ticket cache: FILE:/tmp/krb5cc_1000
Default principal: user@REALM.DOMAIN.COM

Valid starting       Expires              Service principal
30/03/2016 16:23:42  31/03/2016 02:23:42  krbtgt/REALM.DOMAIN.COM@REALM.DOMAIN.COM
        renew until 31/03/2016 16:23:36
```

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

### Configure NetTcpBinding with transport security and certificate credentials

Source: https://github.com/dotnet/wcf/blob/main/src/System.ServiceModel.NetTcp/src/PACKAGE.md

Creates a NetTcpBinding and sets transport-level security with certificate client credentials. Requires the System.ServiceModel.NetTcp namespace.

```csharp
using System;
using System.ServiceModel;
using System.ServiceModel.NetTcp;

NetTcpBinding binding = new NetTcpBinding();
binding.Security.Mode = SecurityMode.Transport;
binding.Security.Transport.ClientCredentialType = TcpClientCredentialType.Certificate;
```

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

### Run unit tests for a single test project

Source: https://github.com/dotnet/wcf/blob/main/Documentation/developer-guide.md

Runs the BuildAndTest target for a specific test project. Use /t:RebuildAndTest to force a rebuild. On non-Windows, call ./Tools/msbuild.sh instead of msbuild.

```bash
cd src\System.ServiceModel.Primitives\tests

msbuild /t:BuildAndTest
```

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

### Run scenario tests against self-hosted service on another machine

Source: https://github.com/dotnet/wcf/blob/main/Documentation/scenario-test-guide.md

Runs scenario tests against a self-hosted test service on a different machine. Replace 'myServer' with the machine name. The Windows command uses build-tests.cmd; the non-Windows command uses build-tests.sh.

```shell
build-tests.cmd -outerloop -- /p:ServiceUri=myServer
```

```shell
./build-tests.sh -outerloop -- /p:ServiceUri=myServer
```

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

### Link PCL reference assemblies

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Links the PCL folder into the Mono prefix to make reference assemblies available for snapshot builds.

```bash
sudo ln -s /usr/lib/mono/xbuild-frameworks/.NETPortable/ $MONO_PREFIX/lib/mono/xbuild-frameworks/
```

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

### Import trusted root certificates

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Imports and syncs trusted root certificates to resolve 'SendFailure (Error writing headers)' errors.

```bash
mozroots --import --sync
```

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

### PCL reference assemblies warning

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Warning shown when the targeted .NETPortable framework profile is not included or reference assemblies are not found.

```text
warning MSB3252: The currently targeted framework ".NETPortable,Version=v4.5,Profile=Profile7" does not include the referenced assembly
MSB3644: The reference assemblies for framework ".NETPortable,Version=v4.5,Profile=Profile7" were not found.
```

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

### dotnet-svcutil [input] [options]

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Generates web service proxy code from a metadata document path, URL, or WS-Addressing EndpointReference. The input can be a local file path, a URL to a service endpoint or metadata document, or an XML file containing an EndpointReference.

```APIDOC
## dotnet-svcutil [input] [options]

### Description
Generates web service proxy code from a metadata document path, URL, or WS-Addressing EndpointReference.

### Usage
```
dotnet-svcutil <metadata document path>|<url>|<epr> [options]
```

### Inputs
- **<metadata document path>** (string) - Required - The path to a metadata document (wsdl or xsd). Standard command-line wildcards can be used in the file path.
- **<url>** (string) - Required - The URL to a service endpoint that provides metadata or to a metadata document hosted online.
- **<epr>** (string) - Required - The path to an XML file that contains a WS-Addressing EndpointReference for a service endpoint that supports WS-Metadata Exchange.

### Options
- **--outputDir <directory>** (string) - Optional - Directory to create files in. Default: A directory called ServiceReference inside the current directory. (Short Form: -d)
- **--noLogo** (flag) - Optional - Suppress the copyright and banner message. (Short Form: -nl)
- **--verbosity <verbosity level>** (string) - Optional - Determines the amount of information displayed by the tool. Valid values are 'Silent, Minimal, Normal, Verbose, Debug'. (Short Form: -v)
- **--help** (flag) - Optional - Display command syntax and options for the tool. (Short Form: -h)
- **--projectFile <project file>** (string) - Optional - The project file to add the client to (if any). (Short Form: -pf)
- **--outputFile <file>** (string) - Optional - The filename for the generated code. Default: derived from the WSDL definition name, WSDL service name or targetNamespace of one of the schemas. (Short Form: -o)
- **--namespace <string,string>** (string) - Optional - A mapping from a WSDL or XML Schema targetNamespace to a CLR namespace. Using the '*' for the targetNamespace maps all targetNamespaces without an explicit mapping to that CLR namespace. Default: derived from the target namespace of the schema document for Data Contracts. The default namespace is used for all other generated types. (Short Form: -n)
- **--messageContract** (flag) - Optional - Generate Message Contract types. (Short Form: -mc)
- **--enableDataBinding** (flag) - Optional - Implement the System.ComponentModel.INotifyPropertyChanged interface on all Data Contract types to enable data binding. (Short Form: -edb)
- **--internal** (flag) - Optional - Generate classes that are marked as internal. Default: generate public classes. (Short Form: -i)
- **--reference <package>** (string) - Optional - Package or project references to reuse types from. When generating clients, use this option to specify references in the user's project that might contain types representing the metadata being imported. The reference can be specified as a nuget package name and version or the path to a .Net Core project. (Short Form: -r)
- **--noTypeReuse** (flag) - Optional - Disable reusing types from project references. References provided with the --reference option will only be considered for resolving collection types specified with the --collectionType option. (Short Form: -ntr)
- **--collectionType <type>** (string) - Optional - A fully-qualified or assembly-qualified name of the type to use as a collection data type when code is generated from schemas. (Short Form: -ct)
- **--excludeType <type>** (string) - Optional - A fully-qualified or assembly-qualified type name to exclude from referenced contract types. (Short Form: -et)
- **--noStdLib** (flag) - Optional - Do not reference standard libraries. By default System.Runtime (mscorlib) and System.ServiceModel (WCF) libraries are referenced. (Short Form: -nsl)
- **--serializer Auto** (flag) - Optional - Automatically select the serializer. This tries to use the Data Contract serializer and uses the XmlSerializer if that fails. (Short Form: -ser)
- **--serializer DataContractSerializer** (flag) - Optional - Generate data types that use the Data Contract Serializer for serialization and deserialization.
- **--serializer XmlSerializer** (flag) - Optional - Generate data types that use the XmlSerializer for serialization and deserialization.
- **--sync** (flag) - Optional - Generate synchronous methods for operations in addition to async. (Short Form: -syn)
- **--wrapped** (flag) - Optional - Generated code will not unwrap "parameters" member of document-wrapped-literal messages. (Short Form: -wr)
- **--update <web service reference>** (string) - Optional - Updates an existing web service reference. If the project contains more than one web service reference, the name of the web service reference to be updated is required. (Short Form: -u)
- **--runtimeIdentifier <runtime identifier>** (string) - Optional - The runtime identifier used for building reference projects (if any). (Short Form: -ri)
- **--targetFramework <framework>** (string) - Optional - The target framework used for building reference projects. (Short Form: -tf)

### Examples
Generate client code from a running service or online metadata documents:
```
dotnet-svcutil http://example.com/service.svc?wsdl
```

Generate client code from a running service using settings that emulate the default "WCF Connected Service" behavior in Visual Studio:
```
dotnet-svcutil http://example.com/service.svc?wsdl -edb -n "*,MyApplication.ServiceReference1" -ct MyLibrary.MyCollection`1 -r "{{MyLibrary,1.0.0}}"
```

Update existing web service reference named ServiceReference. The command need to be executed under directory which contains the project file:
```
dotnet-svcutil -u ServiceReference
```
```

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

### Update existing web service reference

Source: https://github.com/dotnet/wcf/blob/main/src/dotnet-svcutil/README.md

Updates an existing web service reference named ServiceReference. Must be executed in the directory containing the project file.

```bash
dotnet-svcutil -u ServiceReference
```

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

### WCF Client Code (program.cs)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Client code that reads the service URL from an environment variable, creates a channel using BasicHttpBinding, and calls the GetData operation.

```csharp
using HelloWcfService;
using System;
using System.ServiceModel;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            var url = Environment.GetEnvironmentVariable("url");
            var helloEndpoint = new EndpointAddress(url);
            var binding = new BasicHttpBinding();
            var factory = new ChannelFactory<IService1>(binding, helloEndpoint);
            var client = factory.CreateChannel();
            var data = client.GetData(5);
            Console.WriteLine(data);
        }
    }
}
```

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

### libunwind8 missing error

Source: https://github.com/dotnet/wcf/blob/main/Documentation/building/unix-instructions.md

Error indicating that libunwind8 is missing, which is needed by CoreCLR.

```text
EXEC : dlopen failed to open the libcoreclr.so with error libunwind-x86_64.so.8: cannot open shared object file: No such file or directory
```

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

### IIS binding configuration for net.tcp port 808

Source: https://github.com/dotnet/wcf/blob/main/src/System.Private.ServiceModel/tests/Stress/readme.md

Adds a net.tcp binding on port 808 to the Default Web Site in applicationHost.config. Required for the WCF service to accept net.tcp requests.

```xml
<sites> <site name="Default Web Site" id="1"> <bindings>  <binding protocol="net.tcp" bindingInformation="808:*" />
```

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

### WCF Service Contract (IService1.cs)

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseWCFInContainers.md

Default WCF service contract and data contract generated by the project template. Defines the GetData and GetDataUsingDataContract operations and the CompositeType data contract.

```csharp
using System;
using System.Runtime.Serialization;
using System.ServiceModel;

namespace HelloWcfService
{
    [ServiceContract]
    public interface IService1
    {
        [OperationContract]
        string GetData(int value);
        [OperationContract]
        CompositeType GetDataUsingDataContract(CompositeType composite);
    }

    [DataContract]
    public class CompositeType
    {
        bool boolValue = true;
        string stringValue = "Hello ";
        [DataMember]
        public bool BoolValue { get { return boolValue; } set { boolValue = value; } }
        [DataMember]
        public string StringValue  { get { return stringValue; } set { stringValue = value; } }
    }
}
```

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

### Stop ETW logging with logman

Source: https://github.com/dotnet/wcf/blob/main/Documentation/HowToUseETW.md

Stops the ETW trace session named WCFETWTracing. Use this command when you are done collecting logs.

```bash
logman stop WCFETWTracing -ets
```
Tokens:
Raw