merge: '1-ci_pipeline' into 'main'

Resolve "Add CI pipeline and basic test cases for raw bindings"

Closes #1

See merge request namib-master/libraries/tinydtls-rs!2

Author: pulsastrix

.gitlab-ci.yml

@@ -0,0 +1,216 @@
+stages:
+  - test
+  - docs
+  - release
+
+# No longer create push pipeline if MR is created (avoiding duplicate pipelines).
+# See https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
+workflow:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+    - if: '$CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS'
+      when: never
+    - if: '$CI_COMMIT_BRANCH'
+
+# Default image for all builds is the generic controller project build image containing most
+# external dependencies, including rust, clippy, cargo, and C library dependencies.
+# Adding additional dependencies to this image (by opening a MR in the respective project)
+# is strongly preferred to installing dependencies in before_script.
+image: gitlab.informatik.uni-bremen.de:5005/namib-master/ci-docker-images/controller:generic
+
+# Cache definition for the cargo package cache.
+# Pull only by default - the fetch-deps job will update the cache for each build.
+.pkg_cache: &pkg_cache
+  key: "pkgcache-$CI_COMMIT_REF_SLUG"
+  paths:
+    - .cargo/
+  policy: pull
+
+.on_default_branch:
+  - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+.on_tags:
+  - if: '$CI_COMMIT_TAG'
+
+.allow_manual_run:
+  - when: manual
+    allow_failure: true
+
+.on_ready_mrs:
+  - if: '$CI_MERGE_REQUEST_ID && $CI_MERGE_REQUEST_TITLE =~ /^(?:WIP|Draft):.*/'
+
+default:
+  # Use the shared linux Kubernetes cluster for most tasks.
+  tags:
+    - linux
+    - docker
+    - kubernetes
+  # We don't want to keep most artifacts around for longer.
+  artifacts:
+    expire_in: 1 week
+  # retry: 2
+  cache:
+    - *pkg_cache
+
+fetch-deps:
+  stage: .pre
+  cache:
+    - key: !reference [.pkg_cache, key]
+      paths: !reference [.pkg_cache, paths]
+      policy: pull-push
+  script:
+    - cargo fetch
+    - cargo generate-lockfile
+  artifacts:
+    paths:
+      - Cargo.lock # Because this is a library, we need the Cargo.lock to maintain consistency
+
+.test_base:
+  stage: test
+  needs:
+    - job: fetch-deps
+      artifacts: true
+  script:
+    - cargo test --locked -p $PKG_NAME --no-fail-fast -- -Z unstable-options --format json --report-time | tee results.json
+    - cat results.json | cargo2junit > target/$PKG_NAME-test-results.xml
+  artifacts:
+    reports:
+      junit: target/$PKG_NAME-test-results.xml
+
+sys:test:
+  extends: .test_base
+  variables:
+    PKG_NAME: tinydtls-sys
+
+.coverage_base:
+  stage: test
+  allow_failure: true
+  needs:
+    - job: fetch-deps
+      artifacts: true
+  rules:
+    - !reference [.on_tags]
+    - !reference [.on_default_branch]
+    - !reference [.on_ready_mrs]
+    - !reference [.allow_manual_run]
+  script:
+    - cargo tarpaulin --locked --no-fail-fast -p $PKG_NAME --out Xml
+    - mv cobertura.xml target/$PKG_NAME-coverage.xml
+  artifacts:
+    reports:
+      cobertura: target/$PKG_NAME-coverage.xml
+
+sys:coverage:
+  extends: .coverage_base
+  variables:
+    PKG_NAME: tinydtls-sys
+
+.lint_base:
+  stage: test
+  allow_failure: true
+  needs:
+    - job: fetch-deps
+      artifacts: true
+  script:
+    - cargo clippy --locked -p $PKG_NAME -- -D warnings
+  after_script:
+    - cargo clippy --locked -p $PKG_NAME --message-format=json | gitlab-clippy > target/$PKG_NAME-code-quality.json
+  artifacts:
+    reports:
+      codequality: target/$PKG_NAME-code-quality.json
+
+
+sys:lint:
+  extends: .lint_base
+  variables:
+    PKG_NAME: tinydtls-sys
+
+docs:
+  stage: docs
+  allow_failure: true
+  needs:
+    - job: fetch-deps
+      artifacts: true
+  rules:
+    - !reference [.on_default_branch]
+    - !reference [.on_tags]
+    - !reference [.allow_manual_run]
+  script:
+    - cargo doc --locked --workspace --no-deps
+  artifacts:
+    paths:
+      - target/doc
+
+pages:
+  stage: release
+  needs:
+    - docs
+  rules:
+    - !reference [.on_default_branch]
+  script:
+    - mv target/doc public
+    - echo '<meta http-equiv="refresh" content="0;" url="tinydtls_sys/index.html">' > public/index.html
+  artifacts:
+    paths:
+      - public
+
+.publish_cratesio_base:
+  stage: release
+  needs:
+    - job: sys:test
+      artifacts: false
+    - job: docs
+      artifacts: false
+    - job: fetch-deps
+      artifacts: true
+  rules:
+    - if: "$CI_COMMIT_TAG"
+      when: manual
+    - when: never
+  script:
+    - cargo --locked -p $PKG_NAME publish
+
+sys:publish_cratesio:
+  extends: .publish_cratesio_base
+  variables:
+    PKG_NAME: tinydtls-sys
+
+gen-lsif:
+  stage: .post
+  allow_failure: true
+  cache: []
+  needs:
+    - job: fetch-deps # We need the Cargo.lock file in order to run the build script (which can't be disabled)
+      artifacts: true
+  script:
+    - rust-analyzer -v lsif . > tinydtls-rs.lsif
+  artifacts:
+    reports:
+      lsif: tinydtls-rs.lsif
+
+
+variables:
+  # Kubernetes Runner Resource Limiting
+  KUBERNETES_CPU_REQUEST: 4
+  #  KUBERNETES_CPU_LIMIT: 5
+  KUBERNETES_MEMORY_REQUEST: 4Gi
+  KUBERNETES_MEMORY_LIMIT: 4Gi
+  #  KUBERNETES_SERVICE_CPU_REQUEST: 400m
+  #  KUBERNETES_SERVICE_CPU_LIMIT: 400m
+  #  KUBERNETES_SERVICE_MEMORY_REQUEST: 1Gi
+  #  KUBERNETES_SERVICE_MEMORY_LIMIT: 1Gi
+  # ---
+  # Cargo Settings
+  # Number of concurrent build threads to start.
+  # Note: Removing this value somehow causes jobs to randomly get stuck during compilation.
+  CARGO_BUILD_JOBS: 4
+  # Location of Cargo home. Needed for caching.
+  CARGO_HOME: "${CI_PROJECT_DIR}/.cargo"
+  # ---
+  # Fastzip
+  # Use faster cache and artifact compression method.
+  # Increases speed **drastically**, so don't remove it unless it causes issues.
+  FF_USE_FASTZIP: "true"
+  CACHE_COMPRESSION_LEVEL: fast
+  GIT_SUBMODULE_STRATEGY: recursive
+  TRANSFER_METER_FREQUENCY: 5s

README.md

@@ -5,18 +5,19 @@ Rust bindings to the tinydtls library (only raw bindings for now).
 ## License
 
 Matching the license of the tinydtls C library, this library is made available both under
-the terms of the Eclipse Public License v1.0 and 3-Clause BSD License (which the 
+the terms of the Eclipse Public License v1.0 and 3-Clause BSD License (which the
 Eclipse Distribution License v1.0 that is used for tinydtls is based on).
 
-You may choose at your own option which of the two licenses you wish to use for the Rust 
-crate code and the TinyDTLS C library itself, see https://www.eclipse.org/legal/eplfaq.php#DUALLIC.
-
 Additionally, the tinydtls C library contains third party code that might be included
 in compiled binaries that link to tinydtls.
-For information on third-party code and its licenses, see 
+For information on third-party code and its licenses, see
 https://github.com/eclipse/tinydtls/blob/develop/ABOUT.md.
 
-See https://github.com/eclipse/tinydtls/blob/develop/LICENSE for more information.
+See https://github.com/eclipse/tinydtls/blob/develop/LICENSE for more information on the
+tinydtls licensing terms and https://www.eclipse.org/legal/eplfaq.php for more information
+on the EPL 1.0.
+
+Note: This binding is neither supported nor endorsed by the Eclipse Foundation.
 
 ## Maintainers
 

tinydtls-sys/Cargo.toml

@@ -4,23 +4,24 @@
 [package]
 name = "tinydtls-sys"
 description = "Raw bindings to the TinyDTLS library."
-version = "0.1.0-alpha.1+tinydtls-c8d2def"
+version = "0.1.0-alpha.1+tinydtls-68f6045"
 edition = "2021"
 links = "tinydtls"
 # For tinydtls, both licenses can be applied, see https://www.eclipse.org/legal/eplfaq.php#DUALLIC
 # BSD-3-CLAUSE is equivalent to the EDL v1.0, see https://www.eclipse.org/org/documents/edl-v10.php
 # First bracket is the license for TinyDTLS, the remainder is for code included with tinydtls.
 license = "(EPL-1.0 OR BSD-3-CLAUSE) AND BSD-1-Clause AND BSD-3-CLAUSE AND MIT"
 readme = "README.md"
-homepage = "https://namib.me/"
+homepage = "https://github.com/namib-project/tinydtls-rs"
+repository = "https://github.com/namib-project/tinydtls-rs"
 authors = ["Hugo Hakim Damer <[email protected]>"]
 categories = ["external-ffi-bindings", "network-programming", "cryptography", "embedded"]
 keywords = ["tinydtls", "sys", "dtls", "crypto"]
 exclude = ['/src/tinydtls/share/', '/src/tinydtls/include/', '/src/tinydtls/configure.prev']
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [features]
-default = ["vendored"]
+default = ["vendored", "static", "ecc", "psk"]
 # Use a vendored version of tinydtls
 vendored = ["static"]
 # Attempt static linking to tinydtls
@@ -32,9 +33,12 @@ ecc = []
 psk = []
 
 [dependencies]
-libc = "^0.2"
+libc = "^0.2.112"
+
+[dev-dependencies]
+lazy_static = "^1.4"
 
 [build-dependencies]
-bindgen = "0.59.2"
-autotools = "0.2.3"
-fs_extra = "1.2.0"
+bindgen = "^0.59.2"
+autotools = "^0.2.3"
+fs_extra = "^1.2"

tinydtls-sys/README.md

@@ -0,0 +1,30 @@
+# tinydtls-sys
+
+Raw bindings to the [tinydtls C library](https://github.com/eclipse/tinydtls).
+
+## Features
+These features affect the way that the binding is built:
+- `vendored` (default): Build and use a vendored version of tinydtls instead of linking to an existing one.
+- `static` (default): Use static linking instead of dynamic linking
+
+These features affect the functionality of the library (only apply if `vendored` is enabled, we can't control features 
+of binaries that are already built):
+- `ecc` (default): Enable ECC functionality
+- `psk` (default): Enable PSK functionality
+
+## License
+
+Matching the license of the tinydtls C library, this library is made available both under
+the terms of the Eclipse Public License v1.0 and 3-Clause BSD License (which the
+Eclipse Distribution License v1.0 that is used for tinydtls is based on).
+
+Additionally, the tinydtls C library contains third party code that might be included
+in compiled binaries that link to tinydtls.
+For information on third-party code and its licenses, see
+https://github.com/eclipse/tinydtls/blob/develop/ABOUT.md.
+
+See https://github.com/eclipse/tinydtls/blob/develop/LICENSE for more information on the 
+tinydtls licensing terms and https://www.eclipse.org/legal/eplfaq.php for more information 
+on the EPL 1.0.
+
+Note: This binding is neither supported nor endorsed by the Eclipse Foundation.

tinydtls-sys/README.md

@@ -26,8 +26,10 @@ fn main() {
         // TinyDTLS does not like being built out of source, but we get verification errors if files
         // in the source package are modified.
         // Therefore, we copy tinydtls over to the output directory and build from there.
-        let mut copy_options = fs_extra::dir::CopyOptions::default();
-        copy_options.overwrite = true;
+        let copy_options = fs_extra::dir::CopyOptions {
+            overwrite: true,
+            ..Default::default()
+        };
         fs_extra::dir::copy(
             Path::new(env!("CARGO_MANIFEST_DIR")).join("src").join("tinydtls"),
             &out_dir,
@@ -41,7 +43,7 @@ fn main() {
             .unwrap()
             .into_string()
             .unwrap()
-            .split(" ")
+            .split(' ')
             .map(String::from)
             .collect();
 
@@ -67,10 +69,10 @@ fn main() {
 
         // Enable debug symbols if enabled in Rust.
         match std::env::var_os("DEBUG").unwrap().to_str().unwrap() {
-            "0" | "false" => {},
+            "0" | "false" => {}
             _ => {
                 build_config.with("debug", None);
-            },
+            }
         }
 
         // Enable dependency features based on selected cargo features.