Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactoring: extract core and osv #139

Merged
merged 1 commit into from
Dec 18, 2023
Merged

refactoring: extract core and osv #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion .github/workflows/haskell-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,10 @@ jobs:
- name: initial cabal.project for sdist
run: |
touch cabal.project
echo "packages: $GITHUB_WORKSPACE/source/code/hsec-core" >> cabal.project
echo "packages: $GITHUB_WORKSPACE/source/code/hsec-tools" >> cabal.project
echo "packages: $GITHUB_WORKSPACE/source/code/cvss" >> cabal.project
echo "packages: $GITHUB_WORKSPACE/source/code/osv" >> cabal.project
cat cabal.project
- name: sdist
run: |
Expand All @@ -196,20 +198,34 @@ jobs:
run: |
PKGDIR_hsec_tools="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/hsec-tools-[0-9.]*')"
echo "PKGDIR_hsec_tools=${PKGDIR_hsec_tools}" >> "$GITHUB_ENV"
PKGDIR_hsec_tools="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/hsec-tools-[0-9.]*')"
echo "PKGDIR_hsec_tools=${PKGDIR_hsec_tools}" >> "$GITHUB_ENV"
PKGDIR_hsec_core="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/hsec-core-[0-9.]*')"
echo "PKGDIR_hsec_core=${PKGDIR_hsec_core}" >> "$GITHUB_ENV"
PKGDIR_osv="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/osv-[0-9.]*')"
echo "PKGDIR_osv=${PKGDIR_osv}" >> "$GITHUB_ENV"
PKGDIR_cvss="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/cvss-[0-9.]*')"
echo "PKGDIR_cvss=${PKGDIR_cvss}" >> "$GITHUB_ENV"
rm -f cabal.project cabal.project.local
touch cabal.project
touch cabal.project.local
echo "packages: ${PKGDIR_hsec_core}" >> cabal.project
echo "packages: ${PKGDIR_hsec_tools}" >> cabal.project
echo "packages: ${PKGDIR_osv}" >> cabal.project
echo "packages: ${PKGDIR_cvss}" >> cabal.project
echo "package hsec-tools" >> cabal.project
echo " ghc-options: -Werror=missing-methods" >> cabal.project
echo "package hsec-tools" >> cabal.project
echo " ghc-options: -Werror=missing-methods" >> cabal.project
echo "package hsec-core" >> cabal.project
echo " ghc-options: -Werror=missing-methods" >> cabal.project
echo "package osv" >> cabal.project
echo " ghc-options: -Werror=missing-methods" >> cabal.project
echo "package cvss" >> cabal.project
echo " ghc-options: -Werror=missing-methods" >> cabal.project
cat >> cabal.project <<EOF
EOF
$HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(cvss|hsec-tools)$/; }' >> cabal.project.local
$HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(cvss|osv|hsec-core|hsec-tools)$/; }' >> cabal.project.local
cat cabal.project
cat cabal.project.local
- name: dump install plan
Expand Down Expand Up @@ -239,13 +255,19 @@ jobs:
run: |
if [ $((HCNUMVER >= 90400 && HCNUMVER < 90600)) -ne 0 ] ; then (cd ${PKGDIR_hsec_tools} && hlint -XHaskell2010 src) ; fi
if [ $((HCNUMVER >= 90400 && HCNUMVER < 90600)) -ne 0 ] ; then (cd ${PKGDIR_hsec_tools} && hlint -XHaskell2010 app) ; fi
if [ $((HCNUMVER >= 90400 && HCNUMVER < 90600)) -ne 0 ] ; then (cd ${PKGDIR_hsec_core} && hlint -XHaskell2010 src) ; fi
if [ $((HCNUMVER >= 90400 && HCNUMVER < 90600)) -ne 0 ] ; then (cd ${PKGDIR_osv} && hlint -XHaskell2010 src) ; fi
if [ $((HCNUMVER >= 90400 && HCNUMVER < 90600)) -ne 0 ] ; then (cd ${PKGDIR_cvss} && hlint -XHaskell2010 src) ; fi
- name: cabal check
run: |
cd ${PKGDIR_hsec_core} || false
${CABAL} -vnormal check
cd ${PKGDIR_hsec_tools} || false
${CABAL} -vnormal check
cd ${PKGDIR_cvss} || false
${CABAL} -vnormal check
cd ${PKGDIR_osv} || false
${CABAL} -vnormal check
- name: haddock
run: |
$CABAL v2-haddock --disable-documentation --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
Expand Down
2 changes: 2 additions & 0 deletions cabal.project
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
packages: code/*/*.cabal

package hsec-core
package hsec-tools
package cvss
package osv
30 changes: 30 additions & 0 deletions code/hsec-core/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
##### Haskell
dist
dist-*
cabal-dev
*.o
*.hi
*.hie
*.chi
*.chs.h
*.dyn_o
*.dyn_hi
.hpc
.hsenv
.cabal-sandbox/
cabal.sandbox.config
*.prof
*.aux
*.hp
*.eventlog
.stack-work/
cabal.project.local
cabal.project.local~
.HTF/
.ghc.environment.*
build
bin-*

result
.direnv
.env
Empty file added code/hsec-core/CHANGELOG.md
View file
Open in desktop
Empty file.
15 changes: 15 additions & 0 deletions code/hsec-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# hsec-core

`hesc-core` aims to support [Haskell advisories database](https://github.com/haskell/security-advisories).

## Building

We aim to support both regular cabal-based and nix-based builds.

## Testing

Run (and auto update) the golden test:

```ShellSession
cabal test -O0 --test-show-details=direct --test-option=--accept
```
67 changes: 67 additions & 0 deletions code/hsec-core/hsec-core.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
cabal-version: 2.4
name: hsec-core
version: 0.1.0.0

-- A short (one-line) description of the package.
synopsis: Core package representing Haskell advisories

-- A longer description of the package.
description: Core package representing Haskell advisories.

-- A URL where users can report bugs.
-- bug-reports:

-- The license under which the package is released.
license: BSD-3-Clause
author: David Christiansen
maintainer: [email protected]

-- A copyright notice.
-- copyright:
category: Data
extra-doc-files: CHANGELOG.md

tested-with:
GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.3 || ==9.8.1

library
exposed-modules:
Security.Advisories.Core.Advisory
Security.Advisories.Core.HsecId

build-depends:
, base >=4.14 && <4.20
, Cabal-syntax >=3.8.1.0 && <3.11
, cvss
, osv
, pandoc-types >=1.22 && <2
, safe >=0.3
, text >=1.2 && <3
, time >=1.9 && <1.14

-- , commonmark ^>=0.2.2
-- , commonmark-pandoc >=0.2 && <0.3
-- , containers >=0.6 && <0.7
-- , mtl >=2.2 && <2.4
hs-source-dirs: src
default-language: Haskell2010
ghc-options:
-Wall -Wcompat -Widentities -Wincomplete-record-updates
-Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints

test-suite spec
type: exitcode-stdio-1.0
hs-source-dirs: test
main-is: Spec.hs
build-depends:
, base <5
, cvss
, hsec-core
, tasty <1.5
, tasty-hunit <0.11
, text

default-language: Haskell2010
ghc-options:
-Wall -Wcompat -Widentities -Wincomplete-record-updates
-Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints
4 changes: 2 additions & 2 deletions ...ols/src/Security/Advisories/Definition.hs → .../src/Security/Advisories/Core/Advisory.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{-# LANGUAGE DerivingVia #-}

module Security.Advisories.Definition
module Security.Advisories.Core.Advisory
( Advisory(..)
-- * Supporting types
, Affected(..)
Expand All @@ -19,7 +19,7 @@ import Distribution.Types.VersionRange (VersionRange)

import Text.Pandoc.Definition (Pandoc)

import Security.Advisories.HsecId
import Security.Advisories.Core.HsecId
import qualified Security.CVSS as CVSS
import Security.OSV (Reference)

Expand Down
2 changes: 1 addition & 1 deletion ...c-tools/src/Security/Advisories/HsecId.hs → ...re/src/Security/Advisories/Core/HsecId.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module Security.Advisories.HsecId
module Security.Advisories.Core.HsecId
(
HsecId
, hsecIdYear
Expand Down
10 changes: 10 additions & 0 deletions code/hsec-core/test/Spec.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module Main where

import Test.Tasty

main :: IO ()
main =
defaultMain $
testGroup
"Tests"
[]
2 changes: 1 addition & 1 deletion code/hsec-tools/app/Command/Reserve.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Security.Advisories.Git
, explainGitError
, getRepoRoot
)
import Security.Advisories.HsecId
import Security.Advisories.Core.HsecId
( placeholder
, printHsecId
, getNextHsecId
Expand Down
33 changes: 17 additions & 16 deletions code/hsec-tools/hsec-tools.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,37 +33,36 @@ library
exposed-modules:
Security.Advisories
Security.Advisories.Convert.OSV
Security.Advisories.Definition
Security.Advisories.Filesystem
Security.Advisories.Generate.HTML
Security.Advisories.Git
Security.Advisories.HsecId
Security.Advisories.Parse
Security.Advisories.Queries
Security.OSV

build-depends:
, aeson >=2.0.1.0 && <3
, base >=4.14 && <4.20
, Cabal-syntax >=3.8.1.0 && <3.11
, aeson >=2.0.1.0 && <3
, base >=4.14 && <4.20
, Cabal-syntax >=3.8.1.0 && <3.11
, commonmark ^>=0.2.2
, commonmark-pandoc >=0.2 && <0.3
, containers >=0.6 && <0.7
, commonmark-pandoc >=0.2 && <0.3
, containers >=0.6 && <0.7
, cvss
, directory <2
, extra ^>=1.7.5
, filepath >=1.4 && <1.5
, filepath >=1.4 && <1.5
, hsec-core
, lucid >=2.9.0
, mtl >=2.2 && <2.4
, pandoc-types >=1.22 && <2
, parsec >=3 && <4
, mtl >=2.2 && <2.4
, osv
, pandoc-types >=1.22 && <2
, parsec >=3 && <4
, pathwalk >=0.3
, process >=1.6 && <1.7
, process >=1.6 && <1.7
, safe >=0.3
, text >=1.2 && <3
, time >=1.9 && <1.14
, text >=1.2 && <3
, time >=1.9 && <1.14
, toml-parser ^>=1.3.0.0
, validation-selective >=0.1 && <1
, validation-selective >=0.1 && <1

hs-source-dirs: src
default-language: Haskell2010
Expand All @@ -86,6 +85,7 @@ executable hsec-tools
, bytestring >=0.10 && <0.13
, Cabal-syntax >=3.8.1.0 && <3.11
, filepath >=1.4 && <1.5
, hsec-core
, hsec-tools
, optparse-applicative >=0.17 && <0.19
, text >=1.2 && <3
Expand All @@ -108,6 +108,7 @@ test-suite spec
, Cabal-syntax
, cvss
, directory
, hsec-core
, hsec-tools
, pretty-simple <5
, tasty <1.5
Expand Down
Loading