Merge pull request #112 from SIRI-CEN/github_action

Switch travis to github actions
SIRI-CEN · Jun 21, 2023 · a48cfff · a48cfff
2 parents 7c259f0 + c5f3b7b
commit a48cfff
Show file tree

Hide file tree

Showing 172 changed files with 57,867 additions and 57,802 deletions.
diff --git a/.github/scripts/validate-and-lint.sh b/.github/scripts/validate-and-lint.sh
@@ -0,0 +1,30 @@
+#!/bin/bash
+# Validate the XML file structure and lint XSD and XML files, e.g. indentation
+#
+# You need the binary `xmllint`
+# apt-get install libxml2-utils
+
+# The -e flag causes the script to exit as soon as one command returns a non-zero exit code
+set -e
+
+echo "Validating XML file structure and linting XSD and XML files ..."
+
+PARSING_ERROR=0
+# Iterate all XML and XSD files
+while IFS= read -r -d $'\0' filename; do
+  # Prettify the file using xmllint and save the result to ${filename}.pretty
+  if XMLLINT_INDENT=$'\t' xmllint --encode UTF-8 --pretty 1 "${filename}" >"${filename}.pretty"; then
+    # Remove lines containing the term "xmlspy" to get rid of advertising this and save the result as ${filename}
+    grep -i -v "xmlspy" "${filename}.pretty" >"${filename}"
+  else
+    PARSING_ERROR=$?
+    echo -e "\033[0;Validating XML structure of file '${filename}' failed\033[0m"
+  fi
+  # Remove temp file
+  rm "${filename}.pretty"
+done < <(/usr/bin/find . -type f \( -name "*.xsd" -or -name "*.xml" \) -not -path "./git" -print0)
+
+if [ ${PARSING_ERROR} -ne 0 ]; then
+  exit ${PARSING_ERROR}
+fi
+echo -e '\033[0;32mFinished validating XML file structure and linting XSD and XML files\033[0m'
diff --git a/.github/scripts/validate-examples.sh b/.github/scripts/validate-examples.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+# Validate all SIRI XML examples from the examples/ directory against the SIRI XSD schema
+#
+# You need the binary `xmllint`
+# apt-get install libxml2-utils
+
+# The -e flag causes the script to exit as soon as one command returns a non-zero exit code
+set -e
+
+echo "Validating SIRI XML examples ..."
+
+if xmllint --noout --schema xsd/siri.xsd examples/*/*.xml; then
+  echo -e '\033[0;32mValidating SIRI XML examples succeeded\033[0m'
+else
+  echo -e '\033[0;31mValidating SIRI  XML examples failed\033[0m'
+  exit 1
+fi
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  # Triggers the workflow on push or pull request events but only for the "master" branch
+  push:
+    branches: [ "master", "main", "integration" ]
+  pull_request:
+    branches: [ "master", "main", "integration" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    steps:
+      - run: echo "Job was automatically triggered by a ${{ github.event_name }} event for branch ${{ github.ref }}"
+
+      - name: Check out repository code
+        uses: actions/checkout@v3
+        with:
+          # https://github.com/marketplace/actions/add-commit#working-with-prs
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Install xmllint and xsltproc
+        run: |
+          sudo apt-get update
+          sudo apt-get install libxml2-utils xsltproc
+
+      - name: Validate structure and lint XSD and XML files
+        run: ./.github/scripts/validate-and-lint.sh
+
+      - name: Validate SIRI XML examples
+        run: ./.github/scripts/validate-examples.sh
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9 # https://github.com/marketplace/actions/add-commit
+        with:
+          default_author: github_actions
+          message: 'Lint and update documentation tables'
diff --git a/.travis.yml b/.travis.yml
diff --git a/.travis/travis-ci_git-commit.sh b/.travis/travis-ci_git-commit.sh
diff --git a/.travis/xmllint-check.sh b/.travis/xmllint-check.sh
diff --git a/examples/siri_exa_framework/exa_checkStatus_request.xml b/examples/siri_exa_framework/exa_checkStatus_request.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <!-- =======REQUEST================================== -->
- <CheckStatusRequest version="2.0">
-  <RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
-  <RequestorRef>EREWHON</RequestorRef>
- </CheckStatusRequest>
+	<!-- =======REQUEST================================== -->
+	<CheckStatusRequest version="2.0">
+		<RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
+		<RequestorRef>EREWHON</RequestorRef>
+	</CheckStatusRequest>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_checkStatus_response.xml b/examples/siri_exa_framework/exa_checkStatus_response.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <CheckStatusResponse>
-  <ResponseTimestamp>2001-12-17T09:30:47-05:00</ResponseTimestamp>
-  <Status>true</Status>
-  <ValidUntil>2004-12-17T19:30:47-05:00</ValidUntil>
-  <ShortestPossibleCycle>PT2M</ShortestPossibleCycle>
-  <ServiceStartedTime>2004-12-17T09:30:47-05:00</ServiceStartedTime>
- </CheckStatusResponse>
+	<CheckStatusResponse>
+		<ResponseTimestamp>2001-12-17T09:30:47-05:00</ResponseTimestamp>
+		<Status>true</Status>
+		<ValidUntil>2004-12-17T19:30:47-05:00</ValidUntil>
+		<ShortestPossibleCycle>PT2M</ShortestPossibleCycle>
+		<ServiceStartedTime>2004-12-17T09:30:47-05:00</ServiceStartedTime>
+	</CheckStatusResponse>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_dataReady_request.xml b/examples/siri_exa_framework/exa_dataReady_request.xml
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <DataReadyNotification>
-  <RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
-  <ProducerRef>KUBRICK</ProducerRef>
- </DataReadyNotification>
+	<DataReadyNotification>
+		<RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
+		<ProducerRef>KUBRICK</ProducerRef>
+	</DataReadyNotification>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_dataReady_response.xml b/examples/siri_exa_framework/exa_dataReady_response.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <DataReadyAcknowledgement>
-  <ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
-  <ConsumerRef>NADER</ConsumerRef>
-  <Status>true</Status>
- </DataReadyAcknowledgement>
+	<DataReadyAcknowledgement>
+		<ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
+		<ConsumerRef>NADER</ConsumerRef>
+		<Status>true</Status>
+	</DataReadyAcknowledgement>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_dataReceived_response.xml b/examples/siri_exa_framework/exa_dataReceived_response.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <DataReceivedAcknowledgement>
-  <ResponseTimestamp>2001-12-17T09:30:47-05:00</ResponseTimestamp>
-  <ConsumerRef>NADER</ConsumerRef>
-  <RequestMessageRef>012225678</RequestMessageRef>
-  <Status>true</Status>
- </DataReceivedAcknowledgement>
+	<DataReceivedAcknowledgement>
+		<ResponseTimestamp>2001-12-17T09:30:47-05:00</ResponseTimestamp>
+		<ConsumerRef>NADER</ConsumerRef>
+		<RequestMessageRef>012225678</RequestMessageRef>
+		<Status>true</Status>
+	</DataReceivedAcknowledgement>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_dataSupply_request.xml b/examples/siri_exa_framework/exa_dataSupply_request.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <DataSupplyRequest>
-  <RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
-  <ConsumerRef>NADER</ConsumerRef>
-  <NotificationRef>ABCDE0</NotificationRef>
-  <AllData>false</AllData>
- </DataSupplyRequest>
+	<DataSupplyRequest>
+		<RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
+		<ConsumerRef>NADER</ConsumerRef>
+		<NotificationRef>ABCDE0</NotificationRef>
+		<AllData>false</AllData>
+	</DataSupplyRequest>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_heartbeat_request.xml b/examples/siri_exa_framework/exa_heartbeat_request.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <HeartbeatNotification>
-  <RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
-  <ProducerRef>KUBRICK</ProducerRef>
-  <Status>true</Status>
-  <ValidUntil>2004-12-17T09:30:47-05:00</ValidUntil>
-  <ShortestPossibleCycle>P1Y2M3DT10H30M</ShortestPossibleCycle>
-  <ServiceStartedTime>2004-12-17T09:30:47-05:00</ServiceStartedTime>
- </HeartbeatNotification>
+	<HeartbeatNotification>
+		<RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
+		<ProducerRef>KUBRICK</ProducerRef>
+		<Status>true</Status>
+		<ValidUntil>2004-12-17T09:30:47-05:00</ValidUntil>
+		<ShortestPossibleCycle>P1Y2M3DT10H30M</ShortestPossibleCycle>
+		<ServiceStartedTime>2004-12-17T09:30:47-05:00</ServiceStartedTime>
+	</HeartbeatNotification>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_requestSubscription_response.xml b/examples/siri_exa_framework/exa_requestSubscription_response.xml
@@ -1,23 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <SubscriptionResponse>
-  <ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
-  <ResponderRef>EREWHON</ResponderRef>
-  <ResponseStatus>
-   <ResponseTimestamp>2004-12-17T09:30:47-05:01</ResponseTimestamp>
-   <SubscriptionRef>0003456</SubscriptionRef>
-   <Status>true</Status>
-   <ValidUntil>2004-12-17T09:30:47-05:00</ValidUntil>
-   <ShortestPossibleCycle>P1Y2M3DT10H30M</ShortestPossibleCycle>
-  </ResponseStatus>
-  <ResponseStatus>
-   <ResponseTimestamp>2004-12-17T09:30:47-05:02</ResponseTimestamp>
-   <SubscriptionRef>0003457</SubscriptionRef>
-   <Status>false</Status>
-   <ErrorCondition>
-    <NoInfoForTopicError/>
-   </ErrorCondition>
-  </ResponseStatus>
- </SubscriptionResponse>
+	<SubscriptionResponse>
+		<ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
+		<ResponderRef>EREWHON</ResponderRef>
+		<ResponseStatus>
+			<ResponseTimestamp>2004-12-17T09:30:47-05:01</ResponseTimestamp>
+			<SubscriptionRef>0003456</SubscriptionRef>
+			<Status>true</Status>
+			<ValidUntil>2004-12-17T09:30:47-05:00</ValidUntil>
+			<ShortestPossibleCycle>P1Y2M3DT10H30M</ShortestPossibleCycle>
+		</ResponseStatus>
+		<ResponseStatus>
+			<ResponseTimestamp>2004-12-17T09:30:47-05:02</ResponseTimestamp>
+			<SubscriptionRef>0003457</SubscriptionRef>
+			<Status>false</Status>
+			<ErrorCondition>
+				<NoInfoForTopicError/>
+			</ErrorCondition>
+		</ResponseStatus>
+	</SubscriptionResponse>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_subscriptionTerminated_notification.xml b/examples/siri_exa_framework/exa_subscriptionTerminated_notification.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <SubscriptionTerminatedNotification>
-  <ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
-  <ProducerRef>KUBRICK</ProducerRef>
-  <SubscriberRef>NADER</SubscriberRef>
-  <SubscriptionRef>987653</SubscriptionRef>
-  <ErrrorCondition>
-   <OtherError number="123"/>
-   <Description>Weekly restart </Description>
-  </ErrrorCondition>
- </SubscriptionTerminatedNotification>
+	<SubscriptionTerminatedNotification>
+		<ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
+		<ProducerRef>KUBRICK</ProducerRef>
+		<SubscriberRef>NADER</SubscriberRef>
+		<SubscriptionRef>987653</SubscriptionRef>
+		<ErrrorCondition>
+			<OtherError number="123"/>
+			<Description>Weekly restart </Description>
+		</ErrrorCondition>
+	</SubscriptionTerminatedNotification>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_terminateSubscription_request.xml b/examples/siri_exa_framework/exa_terminateSubscription_request.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2014 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <TerminateSubscriptionRequest>
-  <RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
-  <RequestorRef>NADER</RequestorRef>
-  <All/>
- </TerminateSubscriptionRequest>
+	<TerminateSubscriptionRequest>
+		<RequestTimestamp>2004-12-17T09:30:47-05:00</RequestTimestamp>
+		<RequestorRef>NADER</RequestorRef>
+		<All/>
+	</TerminateSubscriptionRequest>
 </Siri>
diff --git a/examples/siri_exa_framework/exa_terminateSubscription_response.xml b/examples/siri_exa_framework/exa_terminateSubscription_response.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- (C) Copyright 2005-2012 CEN SIRI -->
 <Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
- <TerminateSubscriptionResponse>
-  <ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
-  <ResponderRef>KUBRICK</ResponderRef>
-  <TerminationResponseStatus>
-   <ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
-   <SubscriberRef>NADER</SubscriberRef>
-   <SubscriptionRef>0000456</SubscriptionRef>
-   <Status>true</Status>
-  </TerminationResponseStatus>
- </TerminateSubscriptionResponse>
+	<TerminateSubscriptionResponse>
+		<ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
+		<ResponderRef>KUBRICK</ResponderRef>
+		<TerminationResponseStatus>
+			<ResponseTimestamp>2004-12-17T09:30:47-05:00</ResponseTimestamp>
+			<SubscriberRef>NADER</SubscriberRef>
+			<SubscriptionRef>0000456</SubscriptionRef>
+			<Status>true</Status>
+		</TerminationResponseStatus>
+	</TerminateSubscriptionResponse>
 </Siri>