Skip to content

Commit

Permalink
Merge branch 'jira-sync'
Browse files Browse the repository at this point in the history
  • Loading branch information
gcomoretto committed Jul 10, 2019
2 parents 6903b50 + 0dab99c commit 1f32cea
Show file tree
Hide file tree
Showing 8 changed files with 1,131 additions and 51 deletions.
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[submodule "lsst-texmf"]
path = lsst-texmf
url = git@github.com:lsst/lsst-texmf
url = https://github.com/lsst/lsst-texmf
[submodule "images"]
path = images
url = git@github.com:lsst-dm/images
url = https://github.com/lsst-dm/images
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ script:
- "docker run --rm -v `pwd`:/workspace -w /workspace lsstsqre/lsst-texmf:latest sh -c 'make'"
after_success:
# Deploy website. See https://github.com/lsst-sqre/lander for CLI options
- "lander --pdf LDM-552.pdf --upload --lsstdoc LDM-552.tex --env=travis --ltd-product $PRODUCT"
- 'lander --upload --ltd-product ldm-552 --pdf LDM-552.pdf --env travis --lsstdoc LDM-552.tex'
env:
global:
- PRODUCT="ldm-552"
# Add LSST the Docs credentials
- secure: "HLbTqUIImf6nrOGotTG9yeyUPOxjfGGjKd+mNeadb0KEr7ncfnZTcgKqrG+BK84hrs1RNWk05y59kE1Q3fxZJuQ+VdSHDo3cM8fvxHW9KVyazhnAZQLzslIq1yCi+ogWwROKt8OyQ7L2eNfI80SsJDowQ0P8Qfr6yHOIELJrC8Gn+dDYCRjbEEWE3ppqPyFRWPAq1CrIy6hbeLytlV7/XolnNX7GkllbZLR2tTCSCFtlARkhdNhWhKdIJ4ceCiPdk5bCx5n2SAdAtoPm8udzZT7zaEag1OKuS/wJnnXsHbglGYGNn5QKLkVsMOKwqIQ0MXiHha3ku+ItPmUCnS4f8BYc0Nauk/IIFW4blsbJ4x3a97pnb+BZSMwo2/NXbt3BCT0EubfYIv0HEVlf9UYYCLFpcHbflfy94IuhWV0eFKq59iOEKJ11hr1R30DZ1PHGNnU63Lqn1t8QL7TKUaRAARvS1oH8xUXAmBnlZ64pVx2LB4wGI5WwzMBMufi2kLVk24snP6HKwRzuHOi5NNcuvNG73TFSsWZZAV+17rblGNXGscr1ABw8JAb804nIibXWGdeCQ7wb716dYTenbXuLCEeiqf2zVRVN0mgWUaXKVmNjLHfFIRQ3k9SUa6A96gTGe+ioMOv4NYao8n/5Ng5/2DJRwam8PW5/Fqe/HWhctKI="
- secure: "qNHnH84Fs2i3da3ks8RLGB8xXVXVg8Pjl4vHIePNbx6XFp7cTBLbeecqNEpwSq7PTxgNqram9E4bpAp/NKhc/Gkecm+DVmRYx7OFE9zCZ0KRA3Gox9Nf7XY/Nu0h6ZfJK//J5lzQRc57Vswx2euY/Ul2h4HhSiLPLz3rbjI9ih9jPqBkHViw/1FYTJJ+CsnN1sLi3D+yNzOzu7nkdk92AGxBZMtu9ueN4ifanB6Rse+o8R8olx2We8DQWnlAgLxV9DvSlU3+35ICmqQ6eH2o+yQNgjUuY8BSyP5jI5NcR4DXz1AVizhu95srnmyyObX9r27vljKmwcRPizYEHvxhhh6x0BjZWPWc6VrcsSP8fn/ngKM0MOeyUiVJus4zgZZb9mmopBd1b2srydhzY6f4FmscAr+W5TGTagOqJQlyXCRSAzy1eM5Una9MUizccZmwQ0C83Ru2jiyMuYtDQqzyupF+3BY987W5+9dWF5gjedcpao6675FIJXdFUH2pG3sKVrNkQb06i+DY2skZuUGYxyx9fGFDat864VQLliNpvXGKPGnSjUEt8wMoCUfVzgAFxCbv5WNPG/sm4qw7rBiJNT4TSfYN1Doa/yD3yLT8+0fTot/Zsb2+q+LE4BsTa2siJgqnpwXZw1saFjovS8r7eACgnVcyFbF25/Bg/JhW9yE="
106 changes: 67 additions & 39 deletions LDM-552.tex
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
\documentclass[DM,lsstdraft,STS,toc]{lsstdoc}
\usepackage{enumitem}
\usepackage{booktabs}
\usepackage{arydshln}

\input meta.tex

\begin{document}
\setcounter{tocdepth}{2}

\def\product{Qserv}
\def\product{Distributed Database}

\setDocCompact{true}

\title[STS for \product]{\product{} Software Test Specification}

\author{Fritz Mueller}
\setDocRef{\lsstDocType-\lsstDocNum}
\setDocRef{LDM-552}
\date{\vcsdate}
\setDocUpstreamLocation{\url{https://github.com/lsst/LDM-552}}


\setDocAbstract{
This document describes the detailed test specification for the \product{}.
}

\setDocChangeRecord{%
\addtohist{}{2019-06-14}{Autogenerate from Jira.}{G.~Comoretto}
\addtohist{}{2017-07-02}{Initial draft.}{F.~Mueller}
}

\providecommand{\tightlist}{%
\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}

\begin{document}

\maketitle

\section{Introduction}
Expand Down Expand Up @@ -64,12 +74,6 @@ \subsection{Applicable Documents}
\citeds{LDM-555} & LSST DM Database Requirements \\
\end{tabular}

\subsection{References}
\label{sec:references
}
\renewcommand{\refname}{}
\bibliography{lsst,refs,books,refs_ads}

\newpage
\section{Approach}
\label{sec:approach}
Expand Down Expand Up @@ -135,6 +139,42 @@ \subsection{Features to be tested}
and verify that \product{} remains on a realistic path towards meeting its most technically challenging
requirements: those related to successful operability at the scale that will be required by LSST.


\subsubsection{Performances}

In order to ensure that QSERV is able to meet the performance, specific test cases have been designed.
These test cases will be executed each year, in order to denmonstrate that query performances are as described in the following table.


\begin{tabular}{lccccccc}\hline
\multicolumn{2}{c}{\textbf{Query Class}}
&\textbf{2015}&\textbf{2016}&\textbf{2017}&\textbf{2018}&\textbf{2019}&\textbf{2020}\\\hline
\multicolumn{2}{c}{Dataset size, relative to DR-1}
& 10\% & 20\% & 30\% & 50\% & 75\% & 100\% \\ \hline
\multirow{2}{*}{\textbf{LV}}
&\textbf{\# queries} & 50 & 60 & 70 & 80 & 90 & 100 \\%\cline{2-8}
&\textbf{time (sec)} & 10 & 10 & 10 & 10 & 10 & 10 \\\hline
\multirow{2}{*}{\textbf{FTSObj}}
&\textbf{\# queries} & 3 & 4 & 8 & 12 & 16 & 20 \\%\cline{2-8}
&\textbf{time (hours)}& 12 & 1 & 1 & 1 & 1 & 1 \\\hline
\multirow{2}{*}{\textbf{FTSSrc}}
&\textbf{\# queries} & 1 & 1 & 2 & 3 & 4 & 5 \\%\cline{2-8}
&\textbf{time (hours)}& 12 & 12 & 12 & 12 & 12 & 12 \\\hline
\multirow{2}{*}{\textbf{FTSFSrc}}
&\textbf{\# queries} & & 1 & 2 & 3 & 4 & 5 \\%\cline{2-8}
&\textbf{time (hours)}& & 12 & 12 & 12 & 12 & 12 \\\hline
\multirow{2}{*}{\textbf{joinObjSrc}}
&\textbf{\# queries} & 1 & 2 & 4 & 6 & 8 & 10 \\%\cline{2-8}
&\textbf{time (hours)}& 12 & 12 & 12 & 12 & 12 & 12 \\\hline
\multirow{2}{*}{\textbf{joinObjFSrc}}
&\textbf{\# queries} & & 1 & 2 & 3 & 4 & 5 \\%\cline{2-8}
&\textbf{time (hours)}& & 12 & 12 & 12 & 12 & 12 \\\hline
\multirow{2}{*}{\textbf{nearN}}
&\textbf{\# queries} & & 1 & 2 & 3 & 4 & 5 \\%\cline{2-8}
&\textbf{time (hours)}& & 1 & 1 & 1 & 1 & 1 \\\hline
\end{tabular}


\subsection{Features not to be tested}
\label{sec:featnot2test}

Expand Down Expand Up @@ -163,38 +203,26 @@ \subsection{Suspension criteria and resumption requirements}

\subsection{Naming convention}

All tests are named according to the pattern \textsc{prod-scope-xx-yy} where:

\begin{description}[font=\normalfont\scshape]

\item[prod]{The product code, per \citeds{LDM-294}. Relevant entries for this document are:
\begin{description}[font=\normalfont\scshape,topsep=-1.0ex]
\item[qserv]{Qserv distributed database system}
\end{description}
}

\item[scope]{The type of test being described:
\begin{description}[font=\normalfont\scshape,topsep=-1.0ex]
\item[acp]{concerning acceptance testing}
\item[bck]{concerning backup and restore testing}
\item[fun]{concerning functional testing}
\item[ins]{concerning installation testing}
\item[int]{concerning integration testing}
\item[itf]{concerning interface testing}
\item[mnt]{concerning maintenance testing}
\item[prf]{concerning performance testing}
\item[reg]{concerning regression testing}
\item[ver]{concerning verification testing}
\end{description}
}

\item[xx]{Test design number (in increments of 10)}
\item[yy]{Test case number (in increments of 5)}
With the introduction of the Jira Test Management, the following definitions have to be considered:

\begin{description}
\item[LVV]{: Is the label for the ``LSST Verification and Validation'' project in Jira where all information regarding tests are managed.}
\item[LVV-XXX]{: Are Verification Elements, where XXX is the Verification Element identifier. Each Verification Element is derived from a requirement and has at least one Test Case associated. There can be multiple Verification Elements associated with a requirement.}
\item[LVV-TYYY]{: Are Test Cases. Each Test Case is associated with a Verification Element, where YYY is the Test Case identifier. There can be multiple test cases associated with a Verification Element.}
\end{description}

\input{specs/specs.tex}
\input{cases/cases.tex}
\input{procedures/procedures.tex}

\input{jira_docugen.tex}

\newpage
\appendix
\input{jira_docugen.appendix.tex}

\section{References\label{sect:references}}
\renewcommand{\refname}{}
\bibliography{lsst,refs,books,refs_ads,local.bib}

\section{Acronyms \label{sect:acronyms}} % include acronyms.tex generated by the generateAcronyms.py (in texmf/scripts)
\input{acronyms}

\end{document}
32 changes: 25 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,22 +1,37 @@
DOCTYPE = LDM
DOCNUMBER = 552
DOCNAME = $(DOCTYPE)-$(DOCNUMBER)
#for dependency you want all tex files but for acronyms you do not want to include the acronyms file itself.
tex=$(filter-out $(wildcard *aglossary.tex) , $(wildcard *.tex))

export TEXMFHOME = lsst-texmf/texmf
DOC= LDM-552
SRC= $(DOC).tex

#export TEXMFHOME = lsst-texmf/texmf

# Version information extracted from git.
GITVERSION := $(shell git log -1 --date=short --pretty=%h)
GITDATE := $(shell git log -1 --date=short --pretty=%ad)
GITSTATUS := $(shell git status --porcelain)
ifneq "$(GITSTATUS)" ""
GITDIRTY = -dirty
GITDIRTY = -dirty
endif

$(DOCNAME)-$(GITVERSION)$(GITDIRTY).pdf: $(DOCNAME).tex meta.tex
latexmk -bibtex -xelatex -f $(DOCNAME)
OBJ=$(SRC:.tex=.pdf)

#Default when you type make
all: $(OBJ)

$(OBJ): $(tex) meta.tex acronyms.tex
latexmk -bibtex -xelatex -f $(DOC).tex

.FORCE:

acronyms.tex :$(tex) myacronyms.txt
python3 ${TEXMFHOME}/../bin/generateAcronyms.py -t "DM" $(tex)

clean :
latexmk -c
rm *.pdf *.nav *.bbl *.xdv *.snm


meta.tex: Makefile .FORCE
rm -f $@
touch $@
Expand All @@ -25,3 +40,6 @@ meta.tex: Makefile .FORCE
/bin/echo '\newcommand{\lsstDocNum}{$(DOCNUMBER)}' >>$@
/bin/echo '\newcommand{\vcsrevision}{$(GITVERSION)$(GITDIRTY)}' >>$@
/bin/echo '\newcommand{\vcsdate}{$(GITDATE)}' >>$@

myacronyms.txt:
touch myacronyms.txt
57 changes: 57 additions & 0 deletions acronyms.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
\addtocounter{table}{-1}
\begin{longtable}{|p{0.145\textwidth}|p{0.8\textwidth}|}\hline
\textbf{Acronym} & \textbf{Description} \\\hline

ATM & Adaptavist Test Management \\\hline
Archive & The repository for documents required by the NSF to be kept. These include documents related to design and development, construction, integration, test, and operations of the LSST observatory system. The archive is maintained using the enterprise content management system DocuShare, which is accessible through a link on the project website www.project.lsst.org. \\\hline
CC & Change Control \\\hline
CI & Cyber Infrastructure \\\hline
Center & An entity managed by AURA that is responsible for execution of a federally funded project \\\hline
Change Control & The systematic approach to managing all changes to the LSST system, including technical data and policy documentation. The purpose is to ensure that no unnecessary changes are made, all changes are documented, and resources are used efficiently and appropriately. \\\hline
DAC & Data Access Center \\\hline
DM & Data Management \\\hline
DMS & Data Management Subsystem \\\hline
DR & Data Release \\\hline
DRP & Data Release Production \\\hline
Data Access Center & Part of the LSST Data Management System, the US and Chilean DACs will provide authorized access to the released LSST data products, software such as the Science Platform, and computational resources for data analysis. The US DAC also includes a service for distributing bulk data on daily and annual (Data Release) timescales to partner institutions, collaborations, and LSST Education and Public Outreach (EPO). \\\hline
Data Management & The LSST Subsystem responsible for the Data Management System (DMS), which will capture, store, catalog, and serve the LSST dataset to the scientific community and public. The DM team is responsible for the DMS architecture, applications, middleware, infrastructure, algorithms, and Observatory Network Design. DM is a distributed team working at LSST and partner institutions, with the DM Subsystem Manager located at LSST headquarters in Tucson. \\\hline
Data Management Subsystem & The subsystems within Data Management may contain a defined combination of hardware, a software stack, a set of running processes, and the people who manage them: they are a major component of the DM System operations. Examples include the 'Archive Operations Subsystem' and the 'Data Processing Subsystem'"." \\\hline
Data Management System & The computing infrastructure, middleware, and applications that process, store, and enable information extraction from the LSST dataset; the DMS will process peta-scale data volume, convert raw images into a faithful representation of the universe, and archive the results in a useful form. The infrastructure layer consists of the computing, storage, networking hardware, and system software. The middleware layer handles distributed processing, data access, user interface, and system operations services. The applications layer includes the data pipelines and the science data archives' products and services. \\\hline
Data Release & The approximately annual reprocessing of all LSST data, and the installation of the resulting data products in the LSST Data Access Centers, which marks the start of the two-year proprietary period. \\\hline
DocuShare & The trade name for the enterprise management software used by LSST to archive and manage documents \\\hline
Document & Any object (in any application supported by DocuShare or design archives such as PDMWorks or GIT) that supports project management or records milestones and deliverables of the LSST Project \\\hline
EPO & Education and Public Outreach \\\hline
ForcedSource & DRP table resulting from forced photometry. \\\hline
HSC & Hyper Suprime-Cam \\\hline
Handle & The unique identifier assigned to a document uploaded to DocuShare \\\hline
IRSA & Infrared Science Archive \\\hline
LDM & LSST Data Management (Document Handle) \\\hline
LSST & Large Synoptic Survey Telescope \\\hline
NCSA & National Center for Supercomputing Applications \\\hline
Object & In LSST nomenclature this refers to an astronomical object, such as a star, galaxy, or other physical entity. E.g., comets, asteroids are also Objects but typically called a Moving Object or a Solar System Object (SSObject). One of the DRP data products is a table of Objects detected by LSST which can be static, or change brightness or position with time. \\\hline
PDAC & Prototype Data Access Center \\\hline
QA & Quality Assurance \\\hline
Qserv & LSST's distributed parallel database. This database server is used for collecting, storing, and serving LSST Data Release Catalogs and Project metadata, and is part of the Software Stack. \\\hline
RAM & Random Access Memory \\\hline
SDSS & Sloan Digital Sky Survey \\\hline
Science Platform & A set of integrated web applications and services deployed at the LSST Data Access Centers (DACs) through which the scientific community will access, visualize, and perform next-to-the-data analysis of the LSST data products. \\\hline
Scope & The work needed to be accomplished in order to deliver the product, service, or result with the specified features and functions \\\hline
Sloan Digital Sky Survey & is a digital survey of roughly 10,000 square degrees of sky around the north Galactic pole, plus a ~300 square degree stripe along the celestial equator. \\\hline
Software Stack & Often referred to as the LSST Stack, or just The Stack, it is the collection of software written by the LSST Data Management Team to process, generate, and serve LSST images, transient alerts, and catalogs. The Stack includes the LSST Science Pipelines, as well as packages upon which the DM software depends. It is open source and publicly available. \\\hline
Solar System Object & A solar system object is an astrophysical object that is identified as part of the Solar System: planets and their satellites, asteroids, comets, etc. This class of object had historically been referred to within the LSST Project as Moving Objects. \\\hline
Source & A single detection of an astrophysical object in an image, the characteristics for which are stored in the Source Catalog of the DRP database. The association of Sources that are non-moving lead to Objects; the association of moving Sources leads to Solar System Objects. (Note that in non-LSST usage "source" is often used for what LSST calls an Object.) \\\hline
Specification & One or more performance parameter(s) being established by a requirement that the delivered system or subsystem must meet \\\hline
Stripe 82 & A 2.5° wide equatorial band of sky covering roughly 300 square degrees that was observed repeatedly in 5 passbands during the course of the SDSS, In part for calibration purposes. \\\hline
Subsystem & A set of elements comprising a system within the larger LSST system that is responsible for a key technical deliverable of the project. \\\hline
Subsystem Manager & responsible manager for an LSST subsystem; he or she exercises authority, within prescribed limits and under scrutiny of the Project Manager, over the relevant subsystem's cost, schedule, and work plans \\\hline
TB & TeraByte \\\hline
US & United States \\\hline
Validation & A process of confirming that the delivered system will provide its desired functionality; overall, a validation process includes the evaluation, integration, and test activities carried out at the system level to ensure that the final developed system satisfies the intent and performance of that system in operations \\\hline
Verification & The process of evaluating the design, including hardware and software - to ensure the requirements have been met; verification (of requirements) is performed by test, analysis, inspection, and/or demonstration \\\hline
astronomical object & A star, galaxy, asteroid, or other physical object of astronomical interest. Beware: in non-LSST usage, these are often known as sources. \\\hline
calibration & The process of translating signals produced by a measuring instrument such as a telescope and camera into physical units such as flux, which are used for scientific analysis. Calibration removes most of the contributions to the signal from environmental and instrumental factors, such that only the astronomical component remains. \\\hline
forced photometry & A measurement of the photometric properties of a source, or expected source, with one or more parameters held fixed. Most often this means fixing the location of the center of the brightness profile (which may be known or predicted in advance), and measuring other properties such as total brightness, shape, and orientation. Forced photometry will be done for all Objects in the Data Release Production. \\\hline
metadata & General term for data about data, e.g., attributes of astronomical objects (e.g. images, sources, astroObjects, etc.) that are characteristics of the objects themselves, and facilitate the organization, preservation, and query of data sets. (E.g., a FITS header contains metadata). \\\hline
monitoring & In DM QA, this refers to the process of collecting, storing, aggregating and visualizing metrics. \\\hline
stack & a grouping, usually in layers (hence stack), of software packages and services to achieve a common goal. Often providing a higher level set of end user oriented services and tools \\\hline
\end{longtable}

0 comments on commit 1f32cea

Please sign in to comment.