updates

CSVD · Feb 8, 2020 · 30fd0f2 · 30fd0f2
1 parent 0abe7a8
commit 30fd0f2
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 2 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -166,7 +166,7 @@ jobs:
     docker:
       - image: circleci/buildpack-deps:18.04
     environment:
-      SYSLOG: '3.25.1'
+      SYSLOG: 'syslog-ng-3.25.1'
     <<: *build-sc4s
   build-sc4s-master:
     docker:

diff --git a/docs/developing/gh_clone.png b/docs/developing/gh_clone.png
diff --git a/docs/developing/gh_fork.png b/docs/developing/gh_fork.png
diff --git a/docs/developing/index.md b/docs/developing/index.md
@@ -0,0 +1,43 @@
+# Development setup (BETA)
+
+## Get Docker
+
+Development requires Docker desktop available for windows + and mac or Docker CE available for Linux visit (Docker)[https://www.docker.com/get-started]
+for download instructions
+
+## Setup VS Code IDE
+
+VS Code provides a free IDE experience that is effective for daily development with SC4S visit (Microsoft)[https://code.visualstudio.com/docs/introvideos/basics]
+to download and install for your plaform (windows/mac/linux)
+
+## Fork and Clone the github repository
+
+Visit our repository at (Github)[https://github.com/splunk/splunk-connect-for-syslog] and "fork" our repository this will allow you to make changes and submit pull requests.
+
+![How to Fork](gh_fork.png)
+
+Click the clone icon and select the location
+
+![How to Clone](gh_clone.png)
+
+## Setup the project and install requirements
+
+The follow steps are only required on the first time run.
+
+* Install VS Code Extensions S
+    * Python
+    * Test Explorer
+    * "Python Test Explorer"
+* Click the "Run/Debug" bug icon
+* Select the "Setup Project" task and click the Green play icon
+* Select the "Setup Requirements" task and click the Green play icon
+
+![VS Code setup](vsc_run.png)
+
+## Click the test lab icon
+
+* Run all tests this will appear to do nothing for a period system fan may spin loud whiletests are run icons on each test will turn green
+or red to indicate pass fail however VS Code does not show the status of status until the tests complete
+
+![VS Code Debug](vsc_debug.png)
+
diff --git a/docs/developing/vsc_debug.png b/docs/developing/vsc_debug.png
diff --git a/docs/developing/vsc_run.png b/docs/developing/vsc_run.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,6 +10,7 @@ nav:
       - 'Docker CE + Swarm RHEL 7.7': 'gettingstarted/docker-swarm-rhel7.md'
       - 'Bring your own Envionment': 'gettingstarted/byoe-rhel7.md'
   - Configuration: 'configuration.md'
+  - Developing: 'docs/developing/index.md'
   - Sources:
       - About: sources/index.md
       - Checkpoint: sources/Checkpoint/index.md

diff --git a/package/Dockerfile b/package/Dockerfile
@@ -7,7 +7,7 @@
 #You should have received a copy of the CC0 legalcode along with this
 #work.  If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 ARG BRANCH=master
-FROM docker.pkg.github.com/splunk/splunk-syslog-ng-container/splunk-syslog-ng-container:${BRANCH}
+FROM splunk/scs:base-${BRANCH}
 
 COPY --from=hairyhenderson/gomplate:v3.5.0 /gomplate /usr/local/bin/gomplate
 

diff --git a/pytest.ini b/pytest.ini
@@ -3,6 +3,7 @@ testpaths = tests
 addopts =
     -v --tb=long
     --splunk_type=docker
+    --maxfail=1    
 filterwarnings =
     ignore::DeprecationWarning
 junit_family=xunit1