This commit is contained in:
Tommy Parnell
2017-03-05 15:53:17 -05:00
commit 99446ba220
8 changed files with 506 additions and 0 deletions

14
Readme.md Normal file
View File

@@ -0,0 +1,14 @@
This provides a cross platform way to launch processes on mac/linux/or windows.
Simply call `Opener.Open()` with whatever commands you need
common examples
```cs
Opener.Net.Opener.Open("http://google.com"); // launch a browser window
Opener.Net.Opener.Open("npm install", processStartInfo: new ProcessStartInfo(){ WorkingDirectory = "c:/projects/npmrest"}); //npm install in a specific directory
```

287
src/.gitignore vendored Normal file
View File

@@ -0,0 +1,287 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUNIT
*.VisualState.xml
TestResult.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
**/Properties/launchSettings.json
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
# SQL Server files
*.mdf
*.ldf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Typescript v1 declaration files
typings/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# JetBrains Rider
.idea/
*.sln.iml
# CodeRush
.cr/
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs

View File

@@ -0,0 +1,26 @@
using System.Collections.Generic;
using System.Linq;
using Xunit;
namespace Opener.Net.UnitTests
{
public class CliTests
{
[Fact]
public void AssertPlatforms()
{
var results = Opener.LinCommand("npm install");
Assert.Equal(results.Command, "xdg-open");
Assert.Equal(results.Arguments, new List<string>(){ "npm install"});
results = Opener.MacCommand("npm install");
Assert.Equal(results.Command, "open");
Assert.Equal(results.Arguments, new List<string>(){ "npm install"});
results = Opener.WinCommand("npm install");
Assert.Equal(results.Command, "cmd.exe");
Assert.Equal(results.Arguments, new List<string>(){ "/c","start",string.Empty,"npm install"});
}
}
}

View File

@@ -0,0 +1,23 @@
using System;
using System.Diagnostics;
using System.Linq;
using Xunit;
namespace Tests
{
public class Tests
{
[Fact]
public void Test1()
{
var result = Opener.Net.Opener.Open("http://google.com");
result.WaitForExit();
}
[Fact]
public void Test2()
{
var result = Opener.Net.Opener.Open("npm install", processStartInfo: new ProcessStartInfo(){ WorkingDirectory = "c:/projects/npmrest"});
result.WaitForExit();
}
}
}

View File

@@ -0,0 +1,27 @@
{
"version": "1.0.0-*",
"buildOptions": {
"debugType": "portable"
},
"dependencies": {
"Opener.Net": "*",
"System.Runtime.Serialization.Primitives": "4.3.0",
"xunit": "2.1.0",
"dotnet-test-xunit": "1.0.0-rc2-192208-24"
},
"testRunner": "xunit",
"frameworks": {
"netcoreapp1.1": {
"dependencies": {
"Microsoft.NETCore.App": {
"type": "platform",
"version": "1.1.0"
}
},
"imports": [
"dotnet5.4",
"portable-net451+win8"
]
}
}
}

90
src/Opener.Net/Opener.cs Normal file
View File

@@ -0,0 +1,90 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
namespace Opener.Net
{
public class Opener
{
/// <summary>
/// Launch a command on macOS, Linux, or windows
/// </summary>
/// <param name="command">the command to launch</param>
/// <param name="arguments">any arguments you wish to pass</param>
/// <param name="processStartInfo">You may configure the process with the System.Diagnostics.ProcessStartInfo type. However filename, and arguments will be overriden. If this is null, by default stdout/stderr will be redirected</param>
/// <returns></returns>
public static Process Open(string command, IEnumerable<string> arguments = null, ProcessStartInfo processStartInfo = null)
{
var cmdRun = BuildCommand(command, arguments);
var startInfo = processStartInfo ?? new ProcessStartInfo(){
RedirectStandardOutput = true,
RedirectStandardInput = true,
RedirectStandardError = true
};
startInfo.FileName = cmdRun.Command;
startInfo.Arguments = string.Join(" ", cmdRun.Arguments);
return System.Diagnostics.Process.Start(startInfo);
}
internal static ResolvedCommand BuildCommand(string command, IEnumerable<string> arguments = null )
{
ResolvedCommand resolvedCommand;
if(arguments == null) arguments = Enumerable.Empty<string>();
if(RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
resolvedCommand = WinCommand(command, arguments);
//c:/windows/system32/cmd.exe "/c" start "" "usercommand" otherargs
}
else if(RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
resolvedCommand = MacCommand(command, arguments);
//mac "open command"
// open shellCommand args
}
else if(RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
{
resolvedCommand = LinCommand(command, arguments);
//linux "xdg-open" shellCommand args
}
else
{
throw new PlatformNotSupportedException();
}
return resolvedCommand;
}
internal static ResolvedCommand WinCommand(string command, IEnumerable<string> arguments = null)
{
var shellCommand = "cmd.exe";
var args = arguments?.Select(a=>{
return a.Replace("&", "^&");
}).ToList() ?? new List<string>();
args.Insert(0, "/c");
args.Insert(1, "start");
args.Insert(2, string.Empty);
args.Insert(3, command);
return new ResolvedCommand(){Command = shellCommand, Arguments = args};
}
internal static ResolvedCommand LinCommand(string command, IEnumerable<string> arguments = null)
{
var shellCommand = "xdg-open";
var args = arguments?.ToList() ?? new List<string>();
args.Insert(0, command);
return new ResolvedCommand(){ Command = shellCommand, Arguments = args};
}
internal static ResolvedCommand MacCommand(string command, IEnumerable<string> arguments = null)
{
var shellCommand = "open";
var args = arguments?.ToList() ?? new List<string>();
args.Insert(0, command);
return new ResolvedCommand(){ Command = shellCommand, Arguments = args};
}
public class ResolvedCommand
{
public string Command { get; set; }
public List<string> Arguments { get; set; }
}
}
}

View File

@@ -0,0 +1,24 @@
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("Opener.Net")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("Opener.Net")]
[assembly: AssemblyCopyright("Copyright © 2016")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]
[assembly: InternalsVisibleToAttribute("Opener.Net.UnitTests")]
// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("17B419AB-69A2-4376-97E1-D509B6560EC3")]

View File

@@ -0,0 +1,15 @@
{
"version": "1.0.0-*",
"buildOptions": {
"debugType": "portable"
},
"dependencies": {},
"frameworks": {
"netstandard1.4": {
"dependencies": {
"NETStandard.Library": "1.6.1",
"System.Diagnostics.Process": "4.3.0"
}
}
}
}